K4 InDesign Javascript API Documentation

PreferencesTextImportPreference

Text import preferences.

Extends

Instance Properties

Name Description Access
characterSet TextImportCharacterSet The computer language character set used to create the text file. read-write
convertSpacesIntoTabs bool If true, converts the specified number of spaces into a tab. For information on specifying the number of spaces, see spaces into tabs count. read-write
dictionary string The dictionary to use for the imported text. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent Application The parent of the TextImportPreference (a Application). read-only
platform ImportPlatform The platform used to create the imported text file. read-write
properties Object A property that allows setting of several properties at the same time. read-write
spacesIntoTabsCount number The number of spaces to convert to a tab. Note: Valid when convert spaces into tabs is true. read-write
stripReturnsBetweenLines bool If true, the import filter removes extra carriage returns at the ends of lines. read-write
stripReturnsBetweenParagraphs bool If true, the import filter removes extra carriage returns between paragraphs. read-write
useTypographersQuotes bool If true, convert straight quotes and apostrophes in the imported text to typographic quotation marks and apostrophes. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TextImportPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
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)
getElements(
)
  → TextImportPreference
Resolves the object specifier, creating an array of object references.
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 TextImportPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.