InDesign Server2025
API 20.5.0.49
Object

ViewPreference

View preferences.

Preference ViewPreference
Hierarchy

Application | Document

ViewPreference

Properties

NameType AccessDescription
Number | String unit read/write 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)
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number 1–36 read/write The range (in pixels) within which an object snaps to guides. (Range: 1 to 36) Note: Snapping occurs only when guides are shown.
Number 4–256 read/write The distance (in points) between major tick marks on the horizontal ruler. (Range: 4 to 256) Valid only when horizontal measurement units is custom.
MeasurementUnits
+4 more
read/write The measurement unit for the horizontal ruler and other horizontally-measured spaces such as grid columns, horizontal offsets, column gutters, or others.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Application | Document readonly The parent of the ViewPreference (a Application or Document).
Number 60–80 read/write The number of points per inch, typically 72. (Range: 60 to 80)
MeasurementUnits
+4 more
read/write The measurement unit for the print dialog.
Object read/write A property that allows setting of several properties at the same time.
RulerOrigin
read/write The default zero point at the intersection of the vertical and horizontal rulers and the scope of the horizontal ruler.
Boolean read/write If true, displays borders of unselected frames and the diagonal lines in empty unselected frames.
Boolean read/write If true, displays the horizontal and vertical rulers.
MeasurementUnits
+4 more
read/write The measurement unit for stroke measurements.
MeasurementUnits
+4 more
read/write The measurement unit for text size measurements.
MeasurementUnits
+4 more
read/write The measurement units for typography.
Number 4–256 read/write The distance (in points) between major tick marks on the vertical ruler. (Range: 4 to 256) Valid only when vertical measurement units is custom.
MeasurementUnits
+4 more
read/write The measurement unit for the vertical ruler and other vertically-measured spaces such as grid rows, vertical offsets, row heights, or others.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
ViewPreference[]

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

Boolean

Removes the event listener.

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

Generates a string which, if executed, will return the ViewPreference.

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a ViewPreference.

Return 1

Methods that return a ViewPreference.