Adobe InDesign CS4 (6.0) Object Model JS: TextStyleRanges

InDesign CS4

Class

TextStyleRanges

 A collection of text style ranges.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

TextStyleRange anyItem ()
Returns any TextStyleRange in the collection.

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

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

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

TextStyleRange item (index: any)
Returns the TextStyleRange with the specified index or name.

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

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

ParameterTypeDescription
namestringThe name.

Array of TextStyleRange itemByRange (from: any, to: any)
Returns the TextStyleRanges within the specified range.

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

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

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

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

ParameterTypeDescription
objTextStyleRangeThe TextStyleRange whose index comes before the desired TextStyleRange.

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

ParameterTypeDescription
objTextStyleRangeThe index of the TextStyleRange that follows the desired TextStyleRange.

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

Element of

Cell.textStyleRanges

Change.textStyleRanges

Character.textStyleRanges

Footnote.textStyleRanges

HiddenText.textStyleRanges

InsertionPoint.textStyleRanges

Line.textStyleRanges

Note.textStyleRanges

Paragraph.textStyleRanges

Story.textStyleRanges

Text.textStyleRanges

TextColumn.textStyleRanges

TextFrame.textStyleRanges

TextPath.textStyleRanges

TextStyleRange.textStyleRanges

Word.textStyleRanges

XMLElement.textStyleRanges

XmlStory.textStyleRanges

Jongware, 20-Jun-2010 v3.0.3dContents :: Index