ApplicationMacro
Inheritance
The ApplicationMacro object is derived from the Object object.
Usage locations
The ApplicationMacro object can be accessed from the following locations:
- Methods
- ApplicationMacroCollection collection has method Add(table).
- ApplicationMacroCollection collection has method Item(number).
- ApplicationMacroCollection collection has method Item(string).
Property List
Property List (internal only)
- Category
- (Read/Write string)
- Description
- (Read/Write string)
- IconPath
- (Read/Write string)
- IsUserDefined
- (Read/Write boolean)
- Path
- (Read only string)
- Rank
- (Read/Write number)
- ScriptLocation
- (Read/Write FileReference)
- XMLFileName
- (Read/Write string)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
Property Details (internal only)
- Category
- Type
- string
- Access
- Read/Write
- Description
- Type
- string
- Access
- Read/Write
- IconPath
- Type
- string
- Access
- Read/Write
- IsUserDefined
- Type
- boolean
- Access
- Read/Write
- Path
- Type
- string
- Access
- Read only
- Rank
- Type
- number
- Access
- Read/Write
- ScriptLocation
- Type
- FileReference
- Access
- Read/Write
- XMLFileName
- Type
- string
- Access
- Read/Write
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A table defining the properties.
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.