Adobe InDesign CS5.5 (7.5) Object Model JS: Characters

InDesign CS5.5

Class

Characters

 A collection of characters.

See also Character.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

Character anyItem ()
Returns any Character in the collection.

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

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

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

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

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

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

ParameterTypeDescription
fromCharacter
Long Integer
String
The Character, index, or name at the beginning of the range. Can accept: Character, Long Integer or String.
toCharacter
Long Integer
String
The Character, index, or name at the end of the range. Can accept: Character, Long Integer or String.

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

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

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

ParameterTypeDescription
objCharacterThe Character whose index comes before the desired Character.

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

ParameterTypeDescription
objCharacterThe index of the Character that follows the desired Character.

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

Element of

Cell.characters

Change.characters

Character.characters

Footnote.characters

HiddenText.characters

InsertionPoint.characters

Line.characters

Note.characters

Paragraph.characters

Story.characters

Text.characters

TextColumn.characters

TextFrame.characters

TextPath.characters

TextStyleRange.characters

Word.characters

XMLElement.characters

XmlStory.characters

Jongware, 28-Apr-2012 v3.0.3iContents :: Index