Adobe InDesign CS6 (8.0) Object Model JS: HiddenTexts

InDesign CS6

Class

HiddenTexts

 A collection of hidden text objects.

QuickLinks

[], anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

HiddenText [] (index: number)
Returns the HiddenText with the specified index.

ParameterTypeDescription
indexnumberThe index.

HiddenText anyItem ()
Returns any HiddenText in the collection.

number count ()
Displays the number of elements in the HiddenText.

Array of HiddenText everyItem ()
Returns every HiddenText in the collection.

HiddenText firstItem ()
Returns the first HiddenText in the collection.

HiddenText item (index: varies)
Returns the HiddenText with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

HiddenText itemByID (id: number)
Returns the HiddenText with the specified ID.

ParameterTypeDescription
idnumberThe ID.

HiddenText itemByName (name: string)
Returns the HiddenText with the specified name.

ParameterTypeDescription
namestringThe name.

Array of HiddenText itemByRange (from: varies, to: varies)
Returns the HiddenTexts within the specified range.

ParameterTypeDescription
fromHiddenText
Long Integer
String
The HiddenText, index, or name at the beginning of the range. Can accept: HiddenText, Long Integer or String.
toHiddenText
Long Integer
String
The HiddenText, index, or name at the end of the range. Can accept: HiddenText, Long Integer or String.

HiddenText lastItem ()
Returns the last HiddenText in the collection.

HiddenText middleItem ()
Returns the middle HiddenText in the collection.

HiddenText nextItem (obj: HiddenText)
Returns the HiddenText whose index follows the specified HiddenText in the collection.

ParameterTypeDescription
objHiddenTextThe HiddenText whose index comes before the desired HiddenText.

HiddenText previousItem (obj: HiddenText)
Returns the HiddenText with the index previous to the specified index.

ParameterTypeDescription
objHiddenTextThe index of the HiddenText that follows the desired HiddenText.

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

Element of

Cell.hiddenTexts

Character.hiddenTexts

Footnote.hiddenTexts

InsertionPoint.hiddenTexts

Line.hiddenTexts

Note.hiddenTexts

Paragraph.hiddenTexts

Story.hiddenTexts

Table.hiddenTexts

Text.hiddenTexts

TextColumn.hiddenTexts

TextFrame.hiddenTexts

TextStyleRange.hiddenTexts

Word.hiddenTexts

XmlStory.hiddenTexts

Jongware, 28-Apr-2012 v3.0.3hContents :: Index