Adobe InCopy CS5 (7.0) Object Model JS: Language

InCopy CS5

Class

Language

 The language on which to base hyphenation rules and spell checking.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Hierarchy

Document
Language
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
doubleQuotesstring r/wThe double quotes pair for the language.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
hyphenationVendorstring r/wThe hyphenation rules source.
icuLocaleNamestring readonlyThe full name of the Language object's ICU locale.
idnumber readonlyThe unique ID of the Language.
indexnumber readonlyThe index of the Language within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the Language.
parentDocument readonlyThe parent of the Language (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
singleQuotesstring r/wThe single quotes pair for the language.
spellingVendorstring r/wThe spell-checking source.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Language getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

ChangeGrepPreference.appliedLanguage

ChangeTextPreference.appliedLanguage

ChangeTransliteratePreference.appliedLanguage

Character.appliedLanguage

CharacterStyle.appliedLanguage

FindGrepPreference.appliedLanguage

FindTextPreference.appliedLanguage

FindTransliteratePreference.appliedLanguage

InsertionPoint.appliedLanguage

Line.appliedLanguage

Paragraph.appliedLanguage

ParagraphStyle.appliedLanguage

Story.appliedLanguage

Text.appliedLanguage

TextColumn.appliedLanguage

TextDefault.appliedLanguage

TextStyleRange.appliedLanguage

Word.appliedLanguage

XmlStory.appliedLanguage

Used in:

Language Languages.nextItem (obj: Language)

Language Languages.previousItem (obj: Language)

Return

Array of Language Language.getElements ()

Language Languages.[] (index: number)

Language Languages.anyItem ()

Array of Language Languages.everyItem ()

Language Languages.firstItem ()

Language Languages.item (index: varies)

Language Languages.itemByID (id: number)

Language Languages.itemByName (name: string)

Array of Language Languages.itemByRange (from: varies, to: varies)

Language Languages.lastItem ()

Language Languages.middleItem ()

Language Languages.nextItem (obj: Language)

Language Languages.previousItem (obj: Language)

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