InDesign Server2025
API 20.5.0.49
Object

HiddenText

A hidden text object.

Properties

NameType AccessDescription
Characters<Character> readonly A collection of characters.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the HiddenText.
Number readonly The index of the HiddenText within its containing object.
InsertionPoints<InsertionPoint> readonly A collection of insertion points.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
Lines<Line> readonly A collection of lines.
String read/write The name of the HiddenText; this is an alias to the HiddenText's label property.
Paragraphs<Paragraph> readonly A collection of paragraphs.
Cell | EndnoteTextFrame | InsertionPoint | Note | TextFrame | XmlStory | Footnote | Story readonly The parent of the HiddenText (a Story, XmlStory, TextFrame, EndnoteTextFrame, InsertionPoint, Note, Cell or Footnote).
Object read/write A property that allows setting of several properties at the same time.
InsertionPoint readonly The insertion point before the table in the story containing the table.
TextColumns<TextColumn> readonly A collection of text columns.
TextStyleRanges<TextStyleRange> readonly A collection of text style ranges.
Texts<Text> readonly A collection of text objects.
Words<Word> readonly A collection of words.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Gets the label value associated with the specified key.

key String The key.
HiddenText[]

Resolves the object specifier, creating an array of object references.

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Generates a string which, if executed, will return the HiddenText.

String

Retrieves the object specifier.

Object of 11

Properties elsewhere that hold a HiddenText.

Parameter of 3

Method parameters that accept a HiddenText.

Return 13

Methods that return a HiddenText.