HiddenText

A hidden text object.

Methods:

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

Objects:

Boolean, Characters, EventListeners, Events, InsertionPoints, Lines, Number, Object, Paragraphs, String, TextColumns, TextStyleRanges, Texts, Words,

Property Listing

Property

Type

Access

Description

characters

Characters Character

readonly

A collection of characters.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

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 InsertionPoint

readonly

A collection of insertion points.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

lines

Lines Line

readonly

A collection of lines.

name

String

read/write

The name of the HiddenText; this is an alias to the HiddenText's label property.

paragraphs

Paragraphs Paragraph

readonly

A collection of paragraphs.

parent

Cell

EndnoteTextFrame

InsertionPoint

Note

TextFrame

XmlStory

Footnote

Story

readonly

The parent of the HiddenText (a Story, XmlStory, TextFrame, EndnoteTextFrame, InsertionPoint, Note, Cell or Footnote).

properties

Object

read/write

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 TextColumn

readonly

A collection of text columns.

textStyleRanges

TextStyleRanges TextStyleRange

readonly

A collection of text style ranges.

texts

Texts Text

readonly

A collection of text objects.

words

Words Word

readonly

A collection of words.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

HiddenText getElements ()

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

undefined 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.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Character.parent

Event.parent

EventListener.parent

InsertionPoint.parent

Line.parent

MutationEvent.parent

Paragraph.parent

Text.parent

TextColumn.parent

TextStyleRange.parent

Word.parent

Return

HiddenText.getElements()

HiddenTexts.anyItem()

HiddenTexts.everyItem()

HiddenTexts.nextItem()

HiddenTexts.previousItem()

HiddenTexts.itemByID()

HiddenTexts.item()

HiddenTexts.[]()

HiddenTexts.itemByName()

HiddenTexts.itemByRange()

HiddenTexts.firstItem()

HiddenTexts.lastItem()

HiddenTexts.middleItem()