Class

HiddenText

 A hidden text object.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Hierarchy

Cell | Footnote | InsertionPoint | Note | Story | TextFrame | XmlStory
HiddenText
Character | Event | EventListener | InsertionPoint | Line | MutationEvent | Paragraph | Text | TextColumn | TextStyleRange | Word

Properties

PropertyTypeAccessDescription
charactersCharacters readonlyA collection of characters.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the HiddenText.
indexnumber readonlyThe index of the HiddenText within its containing object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
linesLines readonlyA collection of lines.
namestring r/wThe name of the HiddenText; this is an alias to the HiddenText's label property.
paragraphsParagraphs readonlyA collection of paragraphs.
parentCell
Footnote
InsertionPoint
Note
Story
TextFrame
XmlStory
readonlyThe parent of the HiddenText (a Story, XmlStory, TextFrame, InsertionPoint, Note, Cell or Footnote).
propertiesObject r/wA property that allows setting of several properties at the same time.
storyOffsetInsertionPoint readonlyThe insertion point before the table in the story containing the table.
textColumnsTextColumns readonlyA collection of text columns.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
textsTexts readonlyA collection of text objects.
wordsWords readonlyA collection of words.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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:

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, 28-Apr-2012 v3.0.3hContents :: Index