Adobe InCopy CS5.5 (7.5) Object Model JS: MarginPreference

InCopy CS5.5

Class

MarginPreference

 Margin preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | Page
Preference
MarginPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
bottomMeasurement Unit (Number or String) r/wThe bottom edge of the MarginPreference.
columnCountnumber (range: 1 - 216) r/wThe number of columns to place on the page.
columnDirectionHorizontalOrVertical:
HorizontalOrVertical.HORIZONTAL
HorizontalOrVertical.VERTICAL
r/wThe direction of text in the column.
columnGutterMeasurement Unit (Number or String) (range: 0 - 1440) r/wThe distance between columns.
columnsPositions Array of Measurement Unit (Number or String) r/wThe distance that each column guide is placed from the left margin, formatted as an array in the format [guide1, guide2, guide3].
customColumnsbool readonlyIf false, columns are evenly spaced. If true, columns can have custom widths.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
leftMeasurement Unit (Number or String) r/wThe left edge of the MarginPreference.
parentApplication
Document
Page
readonlyThe parent of the MarginPreference (a Application, Document or Page).
propertiesObject r/wA property that allows setting of several properties at the same time.
rightMeasurement Unit (Number or String) r/wThe right edge of the MarginPreference.
topMeasurement Unit (Number or String) r/wThe top edge of the MarginPreference.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.marginPreferences

Document.marginPreferences

Page.marginPreferences

Return

Array of MarginPreference MarginPreference.getElements ()

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