Adobe InCopy CS5 (7.0) Object Model JS: Languages

InCopy CS5

Class

Languages

 A collection of languages.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

Language anyItem ()
Returns any Language in the collection.

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

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

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

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

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

Language itemByID (id: number)
Returns the Language with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLanguage
Long Integer
String
The Language, index, or name at the beginning of the range. Can accept: Language, Long Integer or String.
toLanguage
Long Integer
String
The Language, index, or name at the end of the range. Can accept: Language, Long Integer or String.

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

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

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

ParameterTypeDescription
objLanguageThe Language whose index comes before the desired Language.

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

ParameterTypeDescription
objLanguageThe index of the Language that follows the desired Language.

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

Element of

Document.languages

Jongware, 23-Mar-2011 v3.0.3dContents :: Index