K4 InDesign Javascript API Documentation

TextIndexingSortOptions

A collection of indexing sort options.

Instance Properties

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

Methods

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