K4 InDesign Javascript API Documentation

PreferencesGalleyPreference

Galley preferences.

Extends

Instance Properties

Name Description Access
antiAliasType AntiAliasType The type of text anti-aliasing to use in story and galley views. read-write
backgroundColor The background color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. . Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
blinkCursor bool If true, the cursor blinks. read-write
cursorType CursorTypes The cursor type for galley and story views. read-write
displayFont string Font family name to use for text display. read-write
displayFontSize Measurement Unit (Number or String)=any Size to use for text display. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
infoColumnWidth Measurement Unit (Number or String)=any Info column width. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
lineSpacingValue LineSpacingType Amount of spacing between lines. read-write
parent The parent of the GalleyPreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
showDepthRuler bool If true, displays the depth ruler. read-write
showInfoColumn bool If true, display the Info column. read-write
showParagraphBreakMarks bool If true, show paragraph break marks. read-write
showParagraphStyleNames bool If true, show paragraph style names. read-write
smoothText bool If true, galley text is anti-aliased. read-write
textColor The text color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → GalleyPreference
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(
)
  → GalleyPreference
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 GalleyPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.