GridDataInformation

Grid defaults. Note: Applies to named, layout, and frame (story) grids.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, CharacterAlignment, CharacterCountLocation, EventListeners, Events, Font, GridAlignment, GridViewSettings, LineAlignment, Number, Object, String,

Hierarchy:

Superclass: Preference

Class: GridDataInformation

Property Listing

Property

Type

Access

Description

appliedFont

Font

String

read/write

The font applied to the GridDataInformation, specified as either a font object or the name of font family. Can return: Font or String.

characterAki

Number

read/write

The amount of white space between characters.

characterAlignment

CharacterAlignment

CharacterAlignment.ALIGN_BASELINE

CharacterAlignment.ALIGN_EM_BOTTOM

CharacterAlignment.ALIGN_EM_CENTER

CharacterAlignment.ALIGN_EM_TOP

CharacterAlignment.ALIGN_ICF_BOTTOM

CharacterAlignment.ALIGN_ICF_TOP

read/write

The alignment of small characters to the largest character in the line.

characterCountLocation

CharacterCountLocation

CharacterCountLocation.BOTTOM_ALIGN

CharacterCountLocation.LEFT_ALIGN

CharacterCountLocation.NONE

CharacterCountLocation.RIGHT_ALIGN

CharacterCountLocation.TOP_ALIGN

read/write

The character count location. Note: Valid when show character count is true.

characterCountSize

Number

read/write

The character size for the character count display.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

fontStyle

String

read/write

The name of the font style.

gridAlignment

GridAlignment

GridAlignment.ALIGN_BASELINE

GridAlignment.ALIGN_EM_BOTTOM

GridAlignment.ALIGN_EM_CENTER

GridAlignment.ALIGN_EM_TOP

GridAlignment.ALIGN_ICF_BOTTOM

GridAlignment.ALIGN_ICF_TOP

GridAlignment.NONE

read/write

The alignment to the frame grid or baseline grid.

gridView

GridViewSettings

GridViewSettings.ALIGN_VIEW_ENUM

GridViewSettings.GRID_AND_ZN_VIEW_ENUM

GridViewSettings.GRID_VIEW_ENUM

GridViewSettings.ZN_VIEW_ENUM

read/write

The grid view setting.

horizontalScale

Number

read/write

The horizontal scaling applied to the GridDataInformation.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

lineAki

Number

read/write

The amount of white space between lines.

lineAlignment

LineAlignment

LineAlignment.CENTER_LINE_ALIGN

LineAlignment.CENTER_LINE_JUSTIFY

LineAlignment.FULL_LINE_JUSTIFY

LineAlignment.LEFT_OR_TOP_LINE_ALIGN

LineAlignment.LEFT_OR_TOP_LINE_JUSTIFY

LineAlignment.RIGHT_OR_BOTTOM_LINE_ALIGN

LineAlignment.RIGHT_OR_BOTTOM_LINE_JUSTIFY

read/write

The line justification.

parent

NamedGrid

Page

TextFrame

XmlStory

EndnoteTextFrame

Story

readonly

The parent of the GridDataInformation (a Story, XmlStory, Page, NamedGrid, TextFrame or EndnoteTextFrame).

pointSize

Number

String

read/write

The text size.

properties

Object

read/write

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

verticalScale

Number

read/write

The vertical scaling applied to the GridDataInformation.

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Page.gridData

TextFrame.gridData

Story.gridData

EndnoteTextFrame.gridData

NamedGrid.gridData

XmlStory.gridData

Event.parent

EventListener.parent

MutationEvent.parent

Return

GridDataInformation.getElements()