Clip.AddProperty

UserDataBlobまたはCustomPropertyを作成し、Clip オブジェクトに追加します。

注: このメソッドは Python で無効なオブジェクトを戻す可能性があります。代わりに Clip.AddProperty2 を使用してください。

C#構文

Property Clip.AddProperty( Object in_Preset, Boolean in_Branch, String in_name );

スクリプト構文

oReturn = Clip.AddProperty( Preset, [BranchFlag], [Name] );

戻り値

パラメータ

パラメータタイプ説明

プリセット String この引数には、Property Preset の名前またはファイル名やプリセットファイルへの完全パスを含む文字列が格納されます。

注: クリップには CustomProperty Presets、UserDataBlob Presets、および UserDataMap Presets のみが有効です。

作成されるプロパティのタイプはこの引数により決定されます。たとえば、"CustomProperty" は空の CustomProperty を作成し、"UserDataBlob" は UserDataBlob を作成します。

BranchFlag Boolean False は、唯一のサポートされる値です。
デフォルト値: false

Name String 新しいプロパティの名前を表します（SIObject.Name を参照）。指定しない場合には、オブジェクトは Preset 引数に基づいて名前が付けられます。

例

パラメータ	タイプ	説明
プリセット	String	この引数には、Property Preset の名前またはファイル名やプリセットファイルへの完全パスを含む文字列が格納されます。注: クリップには CustomProperty Presets、UserDataBlob Presets、および UserDataMap Presets のみが有効です。作成されるプロパティのタイプはこの引数により決定されます。たとえば、"CustomProperty" は空の CustomProperty を作成し、"UserDataBlob" は UserDataBlob を作成します。
BranchFlag	Boolean	False は、唯一のサポートされる値です。デフォルト値: false
Name	String	新しいプロパティの名前を表します（SIObject.Name を参照）。指定しない場合には、オブジェクトは Preset 引数に基づいて名前が付けられます。

JScript の例

NewScene( null,false ) ;

var oRoot = ActiveProject.ActiveScene.Root ;

var oGrid = oRoot.AddGeometry( "Grid", "MeshSurface" );

var oGeom = oGrid.ActivePrimitive.Geometry ;

var oClip = oGeom.SaveShapeKey(1) ;

var oPSet = oClip.AddProperty( "CustomProperty",false,"ClipData" ) ;

oPSet.AddParameter3( "StringOnClip", siString ) ;

//You can also store binary data

oClip.AddProperty( "UserDataBlob",false,"MyBlob" ) ;

//The new properties show up on the bottom

//of the PPG

InspectObj( oClip ) ;