Adobe InCopy CS6 (8.0) Object Model JS: LanguageWithVendors

InCopy CS6

Class

LanguageWithVendors

 A language that allows the specification of a hyphenation rules source, a spell-checking source, and a thesaurus.

QuickLinks

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

Hierarchy

Application
LanguageWithVendors
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
dictionaryPaths Array of string r/wThe user dictionaries for the language.
doubleQuotesstring r/wThe double quotes pair for the language.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
hyphenationVendorstring r/wThe hyphenation rules source.
hyphenationVendorList Array of string readonlyA list of hyphenation vendors.
icuLocaleNamestring readonlyThe full name of the Language object's ICU locale.
idnumber readonlyThe unique ID of the LanguageWithVendors.
indexnumber readonlyThe index of the LanguageWithVendors 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 LanguageWithVendors.
parentApplication readonlyThe parent of the LanguageWithVendors (a Application).
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.
spellingVendorList Array of string readonlyA list of spelling vendors.
thesaurusVendorstring r/wThe thesaurus source.

Methods

Instances

string addDictionaryPath (filePath: string)
Adds the specified user dictionary.

ParameterTypeDescription
filePathstringThe path to the dictionary file.

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 LanguageWithVendors 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.

string removeDictionaryPath (filePath: string)
Removes the specified user dictionary.

ParameterTypeDescription
filePathstringThe path to the dictionary file.

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 LanguageWithVendors.

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:

LanguageWithVendors LanguagesWithVendors.nextItem (obj: LanguageWithVendors)

LanguageWithVendors LanguagesWithVendors.previousItem (obj: LanguageWithVendors)

Return

Array of LanguageWithVendors LanguageWithVendors.getElements ()

LanguageWithVendors LanguagesWithVendors.[] (index: number)

LanguageWithVendors LanguagesWithVendors.anyItem ()

Array of LanguageWithVendors LanguagesWithVendors.everyItem ()

LanguageWithVendors LanguagesWithVendors.firstItem ()

LanguageWithVendors LanguagesWithVendors.item (index: varies)

LanguageWithVendors LanguagesWithVendors.itemByID (id: number)

LanguageWithVendors LanguagesWithVendors.itemByName (name: string)

Array of LanguageWithVendors LanguagesWithVendors.itemByRange (from: varies, to: varies)

LanguageWithVendors LanguagesWithVendors.lastItem ()

LanguageWithVendors LanguagesWithVendors.middleItem ()

LanguageWithVendors LanguagesWithVendors.nextItem (obj: LanguageWithVendors)

LanguageWithVendors LanguagesWithVendors.previousItem (obj: LanguageWithVendors)

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