K4 InDesign Javascript API Documentation

TextCharacters

A collection of characters.

Instance Properties

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

Methods

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