K4 InDesign Javascript API Documentation

TextTextStyleRanges

A collection of text style ranges.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

anyItem(
)
  → TextStyleRange
count(
)
  → number
everyItem(
)
  → TextStyleRange
firstItem(
)
  → TextStyleRange
item(
index)
  → TextStyleRange
itemByRange(
from, to)
  → TextStyleRange
lastItem(
)
  → TextStyleRange
middleItem(
)
  → TextStyleRange
nextItem(
obj)
  → TextStyleRange
previousItem(
obj)
  → TextStyleRange
toSource(
)
  → string
anyItem(
)
  → TextStyleRange
Returns any TextStyleRange in the collection.
count(
)
  → number
Displays the number of elements in the TextStyleRange.
everyItem(
)
  → TextStyleRange
Returns every TextStyleRange in the collection.
firstItem(
)
  → TextStyleRange
Returns the first TextStyleRange in the collection.
item(
index)
  → TextStyleRange
Returns the TextStyleRange with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → TextStyleRange
Returns the TextStyleRanges within the specified range.
from The TextStyleRange, index, or name at the beginning of the range. Can accept: TextStyleRange, Long Integer or String.
to The TextStyleRange, index, or name at the end of the range. Can accept: TextStyleRange, Long Integer or String.
lastItem(
)
  → TextStyleRange
Returns the last TextStyleRange in the collection.
middleItem(
)
  → TextStyleRange
Returns the middle TextStyleRange in the collection.
nextItem(
obj)
  → TextStyleRange
Returns the TextStyleRange whose index follows the specified TextStyleRange in the collection.
obj TextStyleRange The TextStyleRange whose index comes before the desired TextStyleRange.
previousItem(
obj)
  → TextStyleRange
Returns the TextStyleRange with the index previous to the specified index.
obj TextStyleRange The index of the TextStyleRange that follows the desired TextStyleRange.
toSource(
)
  → string
Generates a string which, if executed, will return the TextStyleRange.