ObjectStyleGroup
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allObjectStyles | Array of ObjectStyle | readonly | All object styles contained by the ObjectStyleGroup. |
| id | number | readonly | The unique ID of the ObjectStyleGroup. |
| index | number | readonly | The index of the ObjectStyleGroup within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the ObjectStyleGroup. |
| objectStyleGroups | ObjectStyleGroups | readonly | A collection of object style groups. |
| objectStyles | ObjectStyles | readonly | A collection of object styles. |
| parent | ApplicationDocument ObjectStyleGroup |
readonly | The parent of the ObjectStyleGroup (a Document, Application or ObjectStyleGroup). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
Instances
ObjectStyleGroup duplicate ()
Duplicates the ObjectStyleGroup.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of ObjectStyleGroup getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
ObjectStyleGroup move (to:
LocationOptions[, reference:
any])
Moves the ObjectStyleGroup to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The new location relative to the reference object or within the container object. |
| reference | Application Document ObjectStyle ObjectStyleGroup | The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional) |
void remove ([replacingWith:
ObjectStyle])
Deletes the ObjectStyleGroup.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | ObjectStyle | The ObjectStyleGroup to apply in place of the deleted ObjectStyleGroup. (Optional) |
string toSource ()
Generates a string which, if executed, will return the ObjectStyleGroup.
string toSpecifier ()
Retrieves the object specifier.
Element of
ObjectStyle.parent
ObjectStyleGroup.parent
Used in:
ObjectStyle ObjectStyle.move (to: LocationOptions[, reference: any])
ObjectStyleGroup ObjectStyleGroup.move (to: LocationOptions[, reference: any])
array of ObjectStyleGroup ObjectStyleGroups.itemByRange (from: any, to: any)
ObjectStyleGroup ObjectStyleGroups.nextItem (obj: ObjectStyleGroup)
ObjectStyleGroup ObjectStyleGroups.previousItem (obj: ObjectStyleGroup)
Return
ObjectStyleGroup ObjectStyleGroup.duplicate ()
Array of ObjectStyleGroup ObjectStyleGroup.getElements ()
ObjectStyleGroup ObjectStyleGroup.move (to: LocationOptions[, reference: any])
ObjectStyleGroup ObjectStyleGroups.[] (index: number)
ObjectStyleGroup ObjectStyleGroups.add ([withProperties: Object])
ObjectStyleGroup ObjectStyleGroups.anyItem ()
Array of ObjectStyleGroup ObjectStyleGroups.everyItem ()
ObjectStyleGroup ObjectStyleGroups.firstItem ()
ObjectStyleGroup ObjectStyleGroups.item (index: any)
ObjectStyleGroup ObjectStyleGroups.itemByID (id: number)
ObjectStyleGroup ObjectStyleGroups.itemByName (name: string)
Array of ObjectStyleGroup ObjectStyleGroups.itemByRange (from: any, to: any)
ObjectStyleGroup ObjectStyleGroups.lastItem ()
ObjectStyleGroup ObjectStyleGroups.middleItem ()
ObjectStyleGroup ObjectStyleGroups.nextItem (obj: ObjectStyleGroup)
ObjectStyleGroup ObjectStyleGroups.previousItem (obj: ObjectStyleGroup)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |