K4 InDesign Javascript API Documentation

PreferencesViewPreference

View preferences.

Extends

Instance Properties

Name Description Access
cursorKeyIncrement Measurement Unit (Number or String)=any The distance to move a specified object when an arrow key is pressed. (Range depends on the measurement unit. For points: 0.001 to 100; picas: 0p0.001 to 8p4; mm: 0 to 35.278; cm: 0 to 3.5278; inches: 0 to 1.3889; ciceros: 0c0.001 to 7c9.839) read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
guideSnaptoZone number The range (in pixels) within which an object snaps to guides. (Range: 1 to 36) Note: Snapping occurs only when guides are shown. read-write
horizontalCustomPoints number The distance (in points) between major tick marks on the horizontal ruler. (Range: 4 to 256) Valid only when horizontal measurement units is custom. read-write
horizontalMeasurementUnits MeasurementUnits The measurement unit for the horizontal ruler and other horizontally-measured spaces such as grid columns, horizontal offsets, column gutters, or others. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the ViewPreference (a Application or Document). read-only
pointsPerInch number The number of points per inch, typically 72. (Range: 60 to 80) read-write
printDialogMeasurementUnits MeasurementUnits The measurement unit for the print dialog. read-write
properties Object A property that allows setting of several properties at the same time. read-write
rulerOrigin RulerOrigin The default zero point at the intersection of the vertical and horizontal rulers and the scope of the horizontal ruler. read-write
showFrameEdges bool If true, displays borders of unselected frames and the diagonal lines in empty unselected frames. read-write
showNotes bool If true, notes are displayed. read-write
showRulers bool If true, displays the horizontal and vertical rulers. read-write
strokeMeasurementUnits MeasurementUnits The measurement unit for stroke measurements. read-write
textSizeMeasurementUnits MeasurementUnits The measurement unit for text size measurements. read-write
typographicMeasurementUnits MeasurementUnits The measurement units for typography. read-write
verticalCustomPoints number The distance (in points) between major tick marks on the vertical ruler. (Range: 4 to 256) Valid only when vertical measurement units is custom. read-write
verticalMeasurementUnits MeasurementUnits The measurement unit for the vertical ruler and other vertically-measured spaces such as grid rows, vertical offsets, row heights, or others. read-write

Methods

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