TextMacros
See also TextMacro.
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
TextMacro [] (index:
number)
Returns the TextMacro with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
TextMacro add (name:
string, expansion:
string[, withProperties:
Object])
Creates a new text macro.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name of the macro. |
| expansion | string | The expansion text to substitute for the text macro. |
| withProperties | Object | Initial values for properties of the new TextMacro (Optional) |
TextMacro anyItem ()
Returns any TextMacro in the collection.
number count ()
Displays the number of elements in the TextMacro.
Array
of TextMacro everyItem ()
Returns every TextMacro in the collection.
TextMacro firstItem ()
Returns the first TextMacro in the collection.
TextMacro item (index:
varies)
Returns the TextMacro with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
TextMacro itemByName (name:
string)
Returns the TextMacro with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of TextMacro itemByRange (from:
varies, to:
varies)
Returns the TextMacros within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer String TextMacro | The TextMacro, index, or name at the beginning of the range. Can accept: TextMacro, Long Integer or String. |
| to | Long Integer String TextMacro | The TextMacro, index, or name at the end of the range. Can accept: TextMacro, Long Integer or String. |
TextMacro lastItem ()
Returns the last TextMacro in the collection.
TextMacro middleItem ()
Returns the middle TextMacro in the collection.
TextMacro nextItem (obj:
TextMacro)
Returns the TextMacro whose index follows the specified TextMacro in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | TextMacro | The TextMacro whose index comes before the desired TextMacro. |
TextMacro previousItem (obj:
TextMacro)
Returns the TextMacro with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | TextMacro | The index of the TextMacro that follows the desired TextMacro. |
string toSource ()
Generates a string which, if executed, will return the TextMacro.
Element of
Application.textMacros
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |