K4 InDesign Javascript API Documentation

TextLanguageWithVendors

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

Instance Properties

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

Methods

addDictionaryPath(
filePath)
  → string
addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → LanguageWithVendors
insertLabel(
key, value)
removeDictionaryPath(
filePath)
  → string
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addDictionaryPath(
filePath)
  → string
Adds the specified user dictionary.
filePath string The path to the dictionary file.
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → LanguageWithVendors
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
removeDictionaryPath(
filePath)
  → string
Removes the specified user dictionary.
filePath string The path to the dictionary file.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the LanguageWithVendors.
toSpecifier(
)
  → string
Retrieves the object specifier.