MarginPreference

Margin preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, HorizontalOrVertical, Number, Object, String

Hierarchy:

Superclass: Preference

Class: MarginPreference

Property Listing

Property

Type

Access

Description

bottom

Number

String

read/write

The bottom edge of the MarginPreference.

columnCount

Number (range 1 - 216)

read/write

The number of columns to place on the page.

columnDirection

HorizontalOrVertical

HorizontalOrVertical.HORIZONTAL

HorizontalOrVertical.VERTICAL

read/write

The direction of text in the column.

columnGutter

Number

String

read/write

The distance between columns.

columnsPositions

Array of Number

Array of String

read/write

The distance that each column guide is placed from the left margin, formatted as an array in the format [guide1, guide2, guide3].

customColumns

Boolean

readonly

If false, columns are evenly spaced. If true, columns can have custom widths.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

left

Number

String

read/write

The left edge of the MarginPreference.

parent

Document

Application

Page

readonly

The parent of the MarginPreference (a Application, Document or Page).

properties

Object

read/write

A property that allows setting of several properties at the same time.

right

Number

String

read/write

The right edge of the MarginPreference.

top

Number

String

read/write

The top edge of the MarginPreference.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

MarginPreference getElements ()

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.marginPreferences

Document.marginPreferences

Page.marginPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

MarginPreference.getElements()