RingStyles
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
RingStyle add (name:
string[, withProperties:
Object])
Create a new RingStyle
| Parameter | Type | Description |
|---|---|---|
| name | string | The name property of the new RingStyle |
| withProperties | Object | Initial values for properties of the new RingStyle (Optional) |
RingStyle anyItem ()
Returns any RingStyle in the collection.
number count ()
Displays the number of elements in the RingStyle.
Array
of RingStyle everyItem ()
Returns every RingStyle in the collection.
RingStyle firstItem ()
Returns the first RingStyle in the collection.
RingStyle item (index:
any)
Returns the RingStyle with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
RingStyle itemByID (id:
number)
Returns the RingStyle with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
RingStyle itemByName (name:
string)
Returns the RingStyle with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of RingStyle itemByRange (from:
any, to:
any)
Returns the RingStyles within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer RingStyle String | The RingStyle, index, or name at the beginning of the range. Can accept: RingStyle, Long Integer or String. |
| to | Long Integer RingStyle String | The RingStyle, index, or name at the end of the range. Can accept: RingStyle, Long Integer or String. |
RingStyle lastItem ()
Returns the last RingStyle in the collection.
RingStyle middleItem ()
Returns the middle RingStyle in the collection.
RingStyle nextItem (obj:
RingStyle)
Returns the RingStyle whose index follows the specified RingStyle in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | RingStyle | The RingStyle whose index comes before the desired RingStyle. |
RingStyle previousItem (obj:
RingStyle)
Returns the RingStyle with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | RingStyle | The index of the RingStyle that follows the desired RingStyle. |
string toSource ()
Generates a string which, if executed, will return the RingStyle.
Element of
Application.ringStyles
Document.ringStyles
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |