CustomProperty.AddParameter2

説明

新しいカスタムパラメータをカスタムプロパティに追加します。このバージョンのメソッドの動作は CustomProperty.AddParameter の動作と同じです。Jscript 開発者を支援するために、最終的に引数をすべてのデフォルト引数で再配置する点が唯一異なります。

C#構文

Parameter CustomProperty.AddParameter2( String in_ScriptName, siVariantType in_ValueType, Object in_DefaultValue, Object in_Min, Object in_Max, Object in_SuggestedMin, Object in_SuggestedMax, siParamClassification in_Classif, Int32 in_Caps, String in_name, String in_LongName, String in_Guid );

スクリプト構文

oReturn = CustomProperty.AddParameter2( ScriptName, ValueType, [DefaultValue], [Min], [Max], [SuggestedMin], [SuggestedMax], [Classification], [Capabilities], [Name], [Description], [ObsoleteArg] );

戻り値

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

パラメータ

パラメータ タイプ 説明
ScriptName String カスタム パラメータの名前。 この引数は、パラメータの ScriptName を指定します。スペースを含めることはできません（Parameter.ScriptName を参照）。パラメータのショート名またはロング名が指定されていない場合は、この名前が名前および説明として表示されます。
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 を参照）。
SuggestedMin Variant カスタムパラメータの推奨最小値。siString タイプと siBool タイプでは SuggestedMin 値は不要です。デフォルトの推奨最小値（数値）は、0 です。推奨最小値には、最小値以上の値を指定してください。この値は、UI コントロールの範囲設定に使用されます（Parameter.SuggestedMin を参照）。
SuggestedMax Variant カスタムパラメータの推奨最大値。siString タイプと siBool タイプでは SuggestedMax 値は不要です。デフォルトの推奨最大値（数値）は、100 です。推奨最大値には、最大値以下の値を指定してください。この値は、UI コントロールの範囲設定に使用されます（Parameter.SuggestedMax を参照）。
Classification siParamClassification カスタムパラメータの分類

デフォルト値： siClassifUnknown

Capabilities int（Integer を参照） カスタムパラメータの機能。インスペクト不能のカスタムプロパティパラメータを作成すると、そのパラメータはインターフェイスには表示されませんがスクリプトでは使用できます。このパラメータが読み取り専用の場合も、インターフェイスでは淡色表示されますが、スクリプトでは使用できます。siPersistable フラグは省略可能で、すべてのカスタムパラメータに対して有効になります（siCapabilities および Parameter.Capabilities を参照）。

デフォルト値：siPersistable

Name String ユーザフレンドリなカスタムパラメータの名前のバージョン。このパラメータ名はシーン Explorer に表示されます（Show Script Names が有効な場合は例外です）。この引数が指定されない場合は、ScriptName 引数がパラメータ名として表示されます（SIObject.Name および Parameter.ScriptName を参照）。この文字列は、PPGLayout で特定のラベルが指定されていない場合に、カスタムプロパティを検証する際のパラメータラベルとして表示されます。PPGItem.Label を参照してください。

デフォルト値：ScriptName が使用されます。

説明 String カスタムパラメータの長い説明。この文字列はユーザインターフェイスとしては表示されません。

デフォルト値：ScriptName が使用されます。

ObsoleteArg String この引数は、必ずしも指定する必要はありません。

デフォルト値: ""

例

VBScript の例

'VBScript example : add custom parameters to a custom property

MAIN()

sub main()

	On Error Resume Next

	set oRoot = Application.ActiveProject.ActiveScene.Root

	set oSphere = oRoot.AddGeometry("Sphere","NurbsSurface")

	set oProp = oSphere.AddProperty("Custom_parameter_list",,"FirstCustomProperty")

	AddCustomParams(oProp)

	'Show a modeless dialog box with all the parameters that we have added

	InspectObj oProp

end sub

sub AddCustomParams (in_customprop)

	' String custom parameter

	set oParam1 = in_customprop.AddParameter2("StrCustomParam", siString, ,,,,,,,, "the string" )

	write_customprop oParam1

	' Boolean custom parameter

	set oParam2 = in_customprop.AddParameter2("BoolCustomParam", siBool, true, ,,,,,, "ShortName", "LongName" )

	write_customprop oParam2

	' Integer custom parameter

	set oParam3 = in_customprop.AddParameter2("Int2CustomParam", siInt2, -1, -5, 5,,, siClassifVisualization, siAnimatable, "ShortName", "LongName" )

	write_customprop oParam3

	' Double custom parameter

	set oParam4 = in_customprop.AddParameter2("DoubleCustomParam", siDouble, 0.695, 0.0123, 10.456,,,,siReadOnly, "ShortName", "LongName" )

	write_customprop oParam4

end sub

sub write_customprop(in_param)

	LogMessage "Name: " & in_param.Name

	LogMessage "Class: " & typename(in_param)

	LogMessage "Type: " & in_param.Type

	LogMessage "Fullname: " & in_param.FullName

	LogMessage "Parent: " & in_param.Parent.Name

	LogMessage "ScriptName : " & in_param.ScriptName

	LogMessage "Description: " & in_param.Description

	LogMessage "Capabilities : " & in_param.Capabilities

	LogMessage "Value : " & in_param.Value

	LogMessage "ValueType: " & in_param.ValueType

	LogMessage "Default: " & in_param.Default

	if ( in_param.ValueType <> siString ) then 

		LogMessage "Min: " & in_param.Min

		LogMessage "Max: " & in_param.Max

		LogMessage "SuggestedMin: " & in_param.SuggestedMin

		LogMessage "SuggestedMax: " & in_param.SuggestedMax

	end if 

end sub

関連項目

CustomProperty,CustomProperty.AddParameter,Parameter