K4 InDesign Javascript API Documentation

TextHiddenText

A hidden text object.

Instance Properties

Name Description Access
characters Characters A collection of characters. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the HiddenText. read-only
index number The index of the HiddenText within its containing object. read-only
insertionPoints InsertionPoints A collection of insertion points. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
lines Lines A collection of lines. read-only
name string The name of the HiddenText; this is an alias to the HiddenText's label property. read-write
paragraphs Paragraphs A collection of paragraphs. read-only
parent The parent of the HiddenText (a Story, XmlStory, TextFrame, EndnoteTextFrame, InsertionPoint, Note, Cell or Footnote). read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyOffset InsertionPoint The insertion point before the table in the story containing the table. read-only
textColumns TextColumns A collection of text columns. read-only
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
texts Texts A collection of text objects. read-only
words Words A collection of words. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → HiddenText
insertLabel(
key, value)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → HiddenText
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the HiddenText.
toSpecifier(
)
  → string
Retrieves the object specifier.