Adobe InDesign CS5 Server (7.0) Object Model JS: GridDataInformation

InDesign Server CS5

Class

GridDataInformation

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

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

NamedGrid | Page | Story | TextFrame | XmlStory
Preference
GridDataInformation
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
appliedFontFontString r/wThe font applied to the GridDataInformation, specified as either a font object or the name of font family. Can return: Font or String.
characterAkinumber r/wThe amount of white space between characters.
characterAlignmentCharacterAlignment:
CharacterAlignment.ALIGN_BASELINE
CharacterAlignment.ALIGN_EM_TOP
CharacterAlignment.ALIGN_EM_CENTER
CharacterAlignment.ALIGN_EM_BOTTOM
CharacterAlignment.ALIGN_ICF_TOP
CharacterAlignment.ALIGN_ICF_BOTTOM
r/wThe alignment of small characters to the largest character in the line.
characterCountLocationCharacterCountLocation:
CharacterCountLocation.NONE
CharacterCountLocation.TOP_ALIGN
CharacterCountLocation.LEFT_ALIGN
CharacterCountLocation.BOTTOM_ALIGN
CharacterCountLocation.RIGHT_ALIGN
r/wThe character count location. Note: Valid when show character count is true.
characterCountSizenumber r/wThe character size for the character count display.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fontStylestring r/wThe name of the font style.
gridAlignmentGridAlignment:
GridAlignment.NONE
GridAlignment.ALIGN_BASELINE
GridAlignment.ALIGN_EM_TOP
GridAlignment.ALIGN_EM_CENTER
GridAlignment.ALIGN_EM_BOTTOM
GridAlignment.ALIGN_ICF_TOP
GridAlignment.ALIGN_ICF_BOTTOM
r/wThe alignment to the frame grid or baseline grid.
gridViewGridViewSettings:
GridViewSettings.GRID_VIEW_ENUM
GridViewSettings.ZN_VIEW_ENUM
GridViewSettings.ALIGN_VIEW_ENUM
GridViewSettings.GRID_AND_ZN_VIEW_ENUM
r/wThe grid view setting.
horizontalScalenumber r/wThe horizontal scaling applied to the GridDataInformation.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
lineAkinumber r/wThe amount of white space between lines.
lineAlignmentLineAlignment:
LineAlignment.LEFT_OR_TOP_LINE_ALIGN
LineAlignment.CENTER_LINE_ALIGN
LineAlignment.RIGHT_OR_BOTTOM_LINE_ALIGN
LineAlignment.LEFT_OR_TOP_LINE_JUSTIFY
LineAlignment.CENTER_LINE_JUSTIFY
LineAlignment.RIGHT_OR_BOTTOM_LINE_JUSTIFY
LineAlignment.FULL_LINE_JUSTIFY
r/wThe line justification.
parentNamedGrid
Page
Story
TextFrame
XmlStory
readonlyThe parent of the GridDataInformation (a XmlStory, Story, Page, NamedGrid or TextFrame).
pointSizeMeasurement Unit (Number or String) r/wThe text size.
propertiesObject r/wA property that allows setting of several properties at the same time.
verticalScalenumber r/wThe vertical scaling applied to the GridDataInformation.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

NamedGrid.gridData

Page.gridData

Story.gridData

TextFrame.gridData

XmlStory.gridData

Return

Array of GridDataInformation GridDataInformation.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index