`CopyAndTransform_Translate`

Inheritance

The CopyAndTransform_Translate object is derived from the Object object.

Property List

Count: The number of Translate items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Property List (internal only)

NumberOfCopies: (Read/Write number)
Path: (Read only string)
Transform: (Read only Translate)

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.)
Item (index number): Returns the Translate for the given index in the collection. (Returns a Translate object.)
Item (label string): Returns the Translate for the given label in the collection. (Returns a Translate object.)
Items (): Returns a table of Translate items. (Returns a UnsupportedType(List of Translate) 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.

Method List (internal only)

Execute ()

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count

The number of Translate items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Property Details (internal only)

NumberOfCopies

Type: number
Access: Read/Write

Path

Type: string
Access: Read only

Transform

Type: Translate
Access: Read only

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.

Item (index number)

Returns the Translate for the given index in the collection.

Input Parameters

index(number): The index of the Translate.

Return

Translate: The item in the collection

Item (label string)

Returns the Translate for the given label in the collection.

Input Parameters

label(string): The label of the Translate.

Return

Translate: The item in the collection

Items ()

Returns a table of Translate items.

Return

UnsupportedType(List of Translate): The list of items in the collection

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.

Method Details (internal only)

Execute ()

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.