K4 InDesign Javascript API Documentation

PreferencesMarginPreference

Margin preferences.

Extends

Instance Properties

Name Description Access
bottom Measurement Unit (Number or String)=any The bottom edge of the MarginPreference. read-write
columnCount number The number of columns to place on the page. read-write
columnDirection HorizontalOrVertical The direction of text in the column. read-write
columnGutter Measurement Unit (Number or String)=any The distance between columns. read-write
columnsPositions Measurement Unit (Number or String)=any The distance that each column guide is placed from the left margin, formatted as an array in the format [guide1, guide2, guide3]. read-write
customColumns bool If false, columns are evenly spaced. If true, columns can have custom widths. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
left Measurement Unit (Number or String)=any The left edge of the MarginPreference. read-write
parent The parent of the MarginPreference (a Application, Document or Page). read-only
properties Object A property that allows setting of several properties at the same time. read-write
right Measurement Unit (Number or String)=any The right edge of the MarginPreference. read-write
top Measurement Unit (Number or String)=any The top edge of the MarginPreference. read-write

Methods

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