HiddenText
QuickLinks
Hierarchy
Properties
Property | Type | Access | Description |
---|---|---|---|
characters | Characters | readonly | A collection of characters. |
eventListeners | EventListeners | readonly | A collection of event listeners. |
events | Events | readonly | A collection of events. |
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. |
name | string | r/w | The name of the HiddenText; this is an alias to the HiddenText's label property. |
paragraphs | Paragraphs | readonly | A collection of paragraphs. |
parent | CellFootnote InsertionPoint Note Story TextFrame XmlStory |
readonly | The parent of the HiddenText (a Story, XmlStory, 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
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The event type. |
handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
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. |
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The registered event type. |
handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the HiddenText.
Element of
Character.parent
InsertionPoint.parent
Line.parent
Paragraph.parent
Text.parent
TextColumn.parent
TextStyleRange.parent
Word.parent
Used in:
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: varies)
HiddenText HiddenTexts.itemByID (id: number)
HiddenText HiddenTexts.itemByName (name: string)
Array of HiddenText HiddenTexts.itemByRange (from: varies, to: varies)
HiddenText HiddenTexts.lastItem ()
HiddenText HiddenTexts.middleItem ()
HiddenText HiddenTexts.nextItem (obj: HiddenText)
HiddenText HiddenTexts.previousItem (obj: HiddenText)
Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |