Adobe InDesign CS6 Server (8.0) Object Model JS: ViewPreference

InDesign Server CS6

Class

ViewPreference

 View preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
ViewPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
cursorKeyIncrementMeasurement Unit (Number or String) (range: 0.001 - 100) r/wThe 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)
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
guideSnaptoZonenumber (range: 1 - 36) r/wThe range (in pixels) within which an object snaps to guides. (Range: 1 to 36) Note: Snapping occurs only when guides are shown.
horizontalCustomPointsnumber (range: 4 - 256) r/wThe distance (in points) between major tick marks on the horizontal ruler. (Range: 4 to 256) Valid only when horizontal measurement units is custom.
horizontalMeasurementUnitsMeasurementUnits:
MeasurementUnits.POINTS
MeasurementUnits.PICAS
MeasurementUnits.INCHES
MeasurementUnits.INCHES_DECIMAL
MeasurementUnits.MILLIMETERS
MeasurementUnits.CENTIMETERS
MeasurementUnits.CICEROS
MeasurementUnits.CUSTOM
MeasurementUnits.AGATES
MeasurementUnits.U
MeasurementUnits.BAI
MeasurementUnits.MILS
MeasurementUnits.PIXELS
MeasurementUnits.Q
MeasurementUnits.HA
MeasurementUnits.AMERICAN_POINTS
r/wThe measurement unit for the horizontal ruler and other horizontally-measured spaces such as grid columns, horizontal offsets, column gutters, or others.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
readonlyThe parent of the ViewPreference (a Application or Document).
pointsPerInchnumber (range: 60 - 80) r/wThe number of points per inch, typically 72. (Range: 60 to 80)
printDialogMeasurementUnitsMeasurementUnits:
MeasurementUnits.POINTS
MeasurementUnits.PICAS
MeasurementUnits.INCHES
MeasurementUnits.INCHES_DECIMAL
MeasurementUnits.MILLIMETERS
MeasurementUnits.CENTIMETERS
MeasurementUnits.CICEROS
MeasurementUnits.CUSTOM
MeasurementUnits.AGATES
MeasurementUnits.U
MeasurementUnits.BAI
MeasurementUnits.MILS
MeasurementUnits.PIXELS
MeasurementUnits.Q
MeasurementUnits.HA
MeasurementUnits.AMERICAN_POINTS
r/wThe measurement unit for the print dialog.
propertiesObject r/wA property that allows setting of several properties at the same time.
rulerOriginRulerOrigin:
RulerOrigin.SPREAD_ORIGIN
RulerOrigin.PAGE_ORIGIN
RulerOrigin.SPINE_ORIGIN
r/wThe default zero point at the intersection of the vertical and horizontal rulers and the scope of the horizontal ruler.
showFrameEdgesbool r/wIf true, displays borders of unselected frames and the diagonal lines in empty unselected frames.
showRulersbool r/wIf true, displays the horizontal and vertical rulers.
strokeMeasurementUnitsMeasurementUnits:
MeasurementUnits.POINTS
MeasurementUnits.PICAS
MeasurementUnits.INCHES
MeasurementUnits.INCHES_DECIMAL
MeasurementUnits.MILLIMETERS
MeasurementUnits.CENTIMETERS
MeasurementUnits.CICEROS
MeasurementUnits.CUSTOM
MeasurementUnits.AGATES
MeasurementUnits.U
MeasurementUnits.BAI
MeasurementUnits.MILS
MeasurementUnits.PIXELS
MeasurementUnits.Q
MeasurementUnits.HA
MeasurementUnits.AMERICAN_POINTS
r/wThe measurement unit for stroke measurements.
textSizeMeasurementUnitsMeasurementUnits:
MeasurementUnits.POINTS
MeasurementUnits.PICAS
MeasurementUnits.INCHES
MeasurementUnits.INCHES_DECIMAL
MeasurementUnits.MILLIMETERS
MeasurementUnits.CENTIMETERS
MeasurementUnits.CICEROS
MeasurementUnits.CUSTOM
MeasurementUnits.AGATES
MeasurementUnits.U
MeasurementUnits.BAI
MeasurementUnits.MILS
MeasurementUnits.PIXELS
MeasurementUnits.Q
MeasurementUnits.HA
MeasurementUnits.AMERICAN_POINTS
r/wThe measurement unit for text size measurements.
typographicMeasurementUnitsMeasurementUnits:
MeasurementUnits.POINTS
MeasurementUnits.PICAS
MeasurementUnits.INCHES
MeasurementUnits.INCHES_DECIMAL
MeasurementUnits.MILLIMETERS
MeasurementUnits.CENTIMETERS
MeasurementUnits.CICEROS
MeasurementUnits.CUSTOM
MeasurementUnits.AGATES
MeasurementUnits.U
MeasurementUnits.BAI
MeasurementUnits.MILS
MeasurementUnits.PIXELS
MeasurementUnits.Q
MeasurementUnits.HA
MeasurementUnits.AMERICAN_POINTS
r/wThe measurement units for typography.
verticalCustomPointsnumber (range: 4 - 256) r/wThe distance (in points) between major tick marks on the vertical ruler. (Range: 4 to 256) Valid only when vertical measurement units is custom.
verticalMeasurementUnitsMeasurementUnits:
MeasurementUnits.POINTS
MeasurementUnits.PICAS
MeasurementUnits.INCHES
MeasurementUnits.INCHES_DECIMAL
MeasurementUnits.MILLIMETERS
MeasurementUnits.CENTIMETERS
MeasurementUnits.CICEROS
MeasurementUnits.CUSTOM
MeasurementUnits.AGATES
MeasurementUnits.U
MeasurementUnits.BAI
MeasurementUnits.MILS
MeasurementUnits.PIXELS
MeasurementUnits.Q
MeasurementUnits.HA
MeasurementUnits.AMERICAN_POINTS
r/wThe measurement unit for the vertical ruler and other vertically-measured spaces such as grid rows, vertical offsets, row heights, or others.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of ViewPreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.viewPreferences

Document.viewPreferences

Return

Array of ViewPreference ViewPreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3iContents :: Index