HiddenText
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| characters | Characters | readonly | A collection of characters. |
| id | number | readonly | The unique ID of the HiddenText. |
| index | number | readonly | The index of the HiddenText within its containing object. |
| insertionPoints | InsertionPoints | readonly | A collection of insertion points. |
| 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. |
| lines | Lines | readonly | A collection of lines. |
| paragraphs | Paragraphs | readonly | A collection of paragraphs. |
| parent | CellFootnote InsertionPoint Note Story TextFrame |
readonly | The parent of the HiddenText (a Story, TextFrame, InsertionPoint, Note, Cell or Footnote). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| storyOffset | InsertionPoint | readonly | The insertion point before the table in the story containing the table. |
| textColumns | TextColumns | readonly | A collection of text columns. |
| textStyleRanges | TextStyleRanges | readonly | A collection of text style ranges. |
| texts | Texts | readonly | A collection of text objects. |
| words | Words | readonly | A collection of words. |
Methods
Instances
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of HiddenText 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. |
string toSource ()
Generates a string which, if executed, will return the HiddenText.
string toSpecifier ()
Retrieves the object specifier.
Element of
Character.parent
InsertionPoint.parent
Line.parent
Paragraph.parent
Text.parent
TextColumn.parent
TextStyleRange.parent
Word.parent
Used in:
array of HiddenText HiddenTexts.itemByRange (from: any, to: any)
HiddenText HiddenTexts.nextItem (obj: HiddenText)
HiddenText HiddenTexts.previousItem (obj: HiddenText)
Return
Array of HiddenText HiddenText.getElements ()
HiddenText HiddenTexts.[] (index: number)
HiddenText HiddenTexts.anyItem ()
Array of HiddenText HiddenTexts.everyItem ()
HiddenText HiddenTexts.firstItem ()
HiddenText HiddenTexts.item (index: any)
HiddenText HiddenTexts.itemByID (id: number)
HiddenText HiddenTexts.itemByName (name: string)
Array of HiddenText HiddenTexts.itemByRange (from: any, to: any)
HiddenText HiddenTexts.lastItem ()
HiddenText HiddenTexts.middleItem ()
HiddenText HiddenTexts.nextItem (obj: HiddenText)
HiddenText HiddenTexts.previousItem (obj: HiddenText)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |