Adobe InCopy CS5 (7.0) Object Model JS: StaticTexts

InCopy CS5

Class

StaticTexts

 A collection of static text objects.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

StaticText add ([withProperties: Object])
Creates a new StaticText.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new StaticText (Optional)

StaticText anyItem ()
Returns any StaticText in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
fromLong Integer
StaticText
String
The StaticText, index, or name at the beginning of the range. Can accept: StaticText, Long Integer or String.
toLong Integer
StaticText
String
The StaticText, index, or name at the end of the range. Can accept: StaticText, Long Integer or String.

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

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

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

ParameterTypeDescription
objStaticTextThe StaticText whose index comes before the desired StaticText.

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

ParameterTypeDescription
objStaticTextThe index of the StaticText that follows the desired StaticText.

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

Element of

BorderPanel.staticTexts

DialogColumn.staticTexts

DialogRow.staticTexts

EnablingGroup.staticTexts

Jongware, 23-Mar-2011 v3.0.3dContents :: Index