`MockOrderedCollection`

Inheritance

The MockOrderedCollection object is derived from the MockCollection object.

Usage locations

The MockOrderedCollection object can be accessed from the following locations:

Collection lists
- MockModel object has collection MockDomainEntityOrderedCollection.
- SubModelOf_MockModel object has collection MockDomainEntityOrderedCollection.
- MockModelWithGroups object has collection MockDomainEntityOrderedCollection.
- SubModelOf_MockModelWithGroups object has collection MockDomainEntityOrderedCollection.
- SubModelOf_MockModelWithNotes object has collection MockDomainEntityOrderedCollection.

Property List

Count: The number of MockEntity 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)

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

Add (MockArg1 table): (Returns a MockEntity object.)
Add ( number): (Returns a MockEntity object.)
Add ( List of MockEntity): (Returns a MockEntity object.)
AddDefaultEntity (): (Returns a MockEntity object.)
AddMockDomainEntity ( MockEntity): (Returns a MockEntity object.)
AddMockEntityWithPoints ( List of Point): (Returns a MockEntity object.)
AddMockEntityWithUVPoints ( List of UVPoint): (Returns a MockEntity object.)
DeleteEntities ( List of Object)
DuplicateEntities ( List of Object): (Returns a List of Object object.)
MoveDown ( Object)
MoveIn ( List of Object)
MoveUp ( Object)
Replace ( MockEntity, MockEntity)
SetPosition ( List of Object, List of number)

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 MockEntity 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)

Path

Type: string
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 MockEntity for the given index in the collection.

Input Parameters

index(number): The index of the MockEntity.

Return

MockEntity: The item in the collection

Item (label string)

Returns the MockEntity for the given label in the collection.

Input Parameters

label(string): The label of the MockEntity.

Return

MockEntity: The item in the collection

Items ()

Returns a table of MockEntity items.

Return

UnsupportedType(List of MockEntity): 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