Class
View preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
ViewPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| cursorKeyIncrement | Measurement Unit (Number or String) (range: 0.001 - 100) | r/w | 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 | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| guideSnaptoZone | number (range: 1 - 36) | r/w | The range (in pixels) within which an object snaps to guides. (Range: 1 to 36) Note: Snapping occurs only when guides are shown. |
| horizontalCustomPoints | number (range: 4 - 256) | r/w | The distance (in points) between major tick marks on the horizontal ruler. (Range: 4 to 256) Valid only when horizontal measurement units is custom. |
| horizontalMeasurementUnits | MeasurementUnits: 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/w | The measurement unit for the horizontal ruler and other horizontally-measured spaces such as grid columns, horizontal offsets, column gutters, or others. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Application Document |
readonly | The parent of the ViewPreference (a Application or Document). |
| pointsPerInch | number (range: 60 - 80) | r/w | The number of points per inch, typically 72. (Range: 60 to 80) |
| printDialogMeasurementUnits | MeasurementUnits: 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/w | The measurement unit for the print dialog. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rulerOrigin | RulerOrigin: RulerOrigin.SPREAD_ORIGIN RulerOrigin.PAGE_ORIGIN RulerOrigin.SPINE_ORIGIN |
r/w | The default zero point at the intersection of the vertical and horizontal rulers and the scope of the horizontal ruler. |
| showFrameEdges | bool | r/w | If true, displays borders of unselected frames and the diagonal lines in empty unselected frames. |
| showNotes | bool | r/w | If true, notes are displayed. |
| showRulers | bool | r/w | If true, displays the horizontal and vertical rulers. |
| strokeMeasurementUnits | MeasurementUnits: 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/w | The measurement unit for stroke measurements. |
| textSizeMeasurementUnits | MeasurementUnits: 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/w | The measurement unit for text size measurements. |
| typographicMeasurementUnits | MeasurementUnits: 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/w | The measurement units for typography. |
| verticalCustomPoints | number (range: 4 - 256) | r/w | The distance (in points) between major tick marks on the vertical ruler. (Range: 4 to 256) Valid only when vertical measurement units is custom. |
| verticalMeasurementUnits | MeasurementUnits: 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/w | The 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the ViewPreference.
Element of
Application.viewPreferences
Document.viewPreferences
Return
Array of ViewPreference ViewPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |