LanguageWithVendors

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

Go to Property Listing | Method Listing

Methods:

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

Property Listing

Property	Type	Access	Description
dictionaryPaths	Array of String	read/write	The user dictionaries for the language.
doubleQuotes	String	read/write	The double quotes pair for the language.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
hyphenationVendor	String	read/write	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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	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	read/write	A property that allows setting of several properties at the same time.
singleQuotes	String	read/write	The single quotes pair for the language.
spellingVendor	String	read/write	The spell-checking source.
spellingVendorList	Array of String	readonly	A list of spelling vendors.
thesaurusVendor	String	read/write	The thesaurus source.
untranslatedName	String	readonly	The untranslated name of the language.

Method Listing

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 File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

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

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

LanguageWithVendors getElements ()

Resolves the object specifier, creating an array of object references.

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

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