SceneItem.AddCustomProperty
 
 
 

SceneItem.AddCustomProperty

Description

Create and add an empty CustomProperty to a SceneItem object. This method is only suitable for building a new CustomProperty object from scratch. To create a CustomProperty that has already been defined in a Preset or PluginItem use SceneItem.AddProperty.

C# Syntax

CustomProperty SceneItem.AddCustomProperty( String in_name, Boolean in_Branch );

Scripting Syntax

oReturn = SceneItem.AddCustomProperty( [Name], [BranchFlag] );

Return Value

CustomProperty

Parameters

Parameter Type Description
Name String Represents the name of the new custom property
BranchFlag Boolean Add property on branch or the node of object.

Default Value: false

Examples

VBScript Example

'VBScript example
set sceneItem = Application.ActiveProject.ActiveScene.Root.AddNull
set prop = sceneItem.AddCustomProperty
LogMessage "SceneItem's custom property name: " & prop.FullName