CustomProperty.AddParameter3

説明

新しいカスタムパラメータをカスタムプロパティに追加します。このバージョンは、CustomProperty.AddParameter2 の単純化バージョンです。

特に使用頻度の高い siCapabilities フラグである siAnimatable および SiReadOnly は、オプションの引数として直接表示されます。

ほとんどのパラメータは、このメソッドを使って指定できます。ただし、パラメータが UI range、特定の分類フラグ、またはユーザ名を必要とする場合は、CustomProperty.AddParameter または CustomProperty.AddParameter2 の使用を考慮してください。

C#構文

Parameter CustomProperty.AddParameter3( String in_ScriptName, siVariantType in_ValueType, Object in_DefaultValue, Object in_Min, Object in_Max, Boolean in_bAnimatable, Boolean in_bReadOnly );

スクリプト構文

oReturn = CustomProperty.AddParameter3( ScriptName, ValueType, [DefaultValue], [Min], [Max], [Animatable], [ReadOnly] );

戻り値

新しく作成された Parameter オブジェクト

パラメータ

パラメータ タイプ 説明
ScriptName String カスタム パラメータの名前。 この引数は、Parameter.ScriptName および SIObject.Name の両方を指定します。スペースを含めることはできません。
ValueType siVariantType カスタムパラメータのタイプ。推奨タイプは siString、siBool、siInt4、siUByte、および siFloat です(Parameter.ValueType を参照)。
DefaultValue Variant カスタムパラメータのデフォルト値。ブール値および数値の場合のデフォルト値は 0 で、文字列のデフォルト値は""です。(Parameter.Default を参照)。
Min Variant カスタムパラメータの最小値。siString タイプと siBool タイプでは Min 値は不要です。その他の数値タイプでは、デフォルト値をそのタイプの最小値にすることができます。たとえば、すべての未署名値には min=0 が設定されます(Parameter.Min を参照)。
Max Variant カスタムパラメータの最大値。siString タイプと siBool タイプでは Max 値は不要です。その他の数値タイプでは、デフォルト値をそのタイプの最小値にすることができます。たとえば、siUByte の最大値は 255 です(Parameter.Max を参照)。
Animatable Boolean パラメータがアニメーションをサポートするように指定します。この引数は、アニメーションをサポートしない文字列パラメータでは無視されます。Parameter.Animatable を使用すると、パラメータの特定インスタンスに対してこの設定を上書きすることができます。

デフォルト値:true

ReadOnly Boolean このパラメータの値をユーザが変更できないことを指定します。読み取り専用パラメータの場合はスクリプトを使用して変更できます(Parameter.Value を参照)。Parameter.ReadOnly を使用すると、パラメータの特定インスタンスに対してこの設定を上書きすることができます。

デフォルト値: false

関連項目

CustomProperty, CustomProperty.AddParameter2, Parameter siCapabilities