Adobe InDesign CS5 (7.0) Object Model JS: HiddenText

previous page next page

Class

HiddenText

A hidden text object.

HiddenText

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	Cell Footnote 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.

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)