AddProperty (Source)
Introduced
4.0
Description
Creates and adds a UserDataBlob or CustomProperty to a Source object.
Scripting Syntax
Source.AddProperty( Preset, [BranchFlag], [Name] )
C# Syntax
Property Source.AddProperty( Object in_Preset, Boolean in_Branch, String in_name );Parameters
|
Parameter |
Type |
Description |
|
Preset |
This argument contains either the name of a Property Preset or a string with the filename or full path to a Preset file. Note: Only CustomProperty Presets, UserDataBlob Presets, and UserDataMap Presets are valid for sources. The type of property that is created is determined by this argument. For example, "CustomProperty" creates an empty CustomProperty and "UserDataBlob" creates a UserDataBlob. |
|
|
BranchFlag |
False is the only supported value Default Value: false |
|
|
Name |
Represents the name of the new property (see SIObject.Name). If not specified the object is named based on the Preset argument. |
Return Value
CustomProperty, UserDataBlob or UserDataMap, depending on the preset that was used.
See Also
Examples
• See Source.AddProperty.1.js
Autodesk Softimage 2011