Adobe InCopy CS5 (7.0) Object Model JS: LanguageWithVendors

previous page next page

Class

LanguageWithVendors

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

LanguageWithVendors

Property	Type	Access	Description
dictionaryPaths	Array of string	r/w	The user dictionaries for the language.
doubleQuotes	string	r/w	The double quotes pair for the language.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
hyphenationVendor	string	r/w	The hyphenation rules source.
hyphenationVendorList	Array of string	readonly	A list of hyphenation vendors.
icuLocaleName	string	readonly	The full name of the Language object's ICU locale.
id	number	readonly	The unique ID of the LanguageWithVendors.
index	number	readonly	The index of the LanguageWithVendors within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	readonly	The name of the LanguageWithVendors.
parent	Application	readonly	The parent of the LanguageWithVendors (a Application).
properties	Object	r/w	A property that allows setting of several properties at the same time.
singleQuotes	string	r/w	The single quotes pair for the language.
spellingVendor	string	r/w	The spell-checking source.
spellingVendorList	Array of string	readonly	A list of spelling vendors.
thesaurusVendor	string	r/w	The thesaurus source.

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

Parameter	Type	Description
filePath	string	The path to the dictionary file.

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

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

Parameter	Type	Description
filePath	string	The path to the dictionary file.

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

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)