Class
Grid defaults. Note: Applies to named, layout, and frame (story) grids. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
GridDataInformation
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| appliedFont | FontString | r/w | 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 | r/w | The amount of white space between characters. |
| characterAlignment | CharacterAlignment: CharacterAlignment.ALIGN_BASELINE CharacterAlignment.ALIGN_EM_TOP CharacterAlignment.ALIGN_EM_CENTER CharacterAlignment.ALIGN_EM_BOTTOM CharacterAlignment.ALIGN_ICF_TOP CharacterAlignment.ALIGN_ICF_BOTTOM |
r/w | The alignment of small characters to the largest character in the line. |
| characterCountLocation | CharacterCountLocation: CharacterCountLocation.NONE CharacterCountLocation.TOP_ALIGN CharacterCountLocation.LEFT_ALIGN CharacterCountLocation.BOTTOM_ALIGN CharacterCountLocation.RIGHT_ALIGN |
r/w | The character count location. Note: Valid when show character count is true. |
| characterCountSize | number | r/w | 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 | r/w | The name of the font style. |
| gridAlignment | GridAlignment: 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/w | The alignment to the frame grid or baseline grid. |
| gridView | GridViewSettings: GridViewSettings.GRID_VIEW_ENUM GridViewSettings.ZN_VIEW_ENUM GridViewSettings.ALIGN_VIEW_ENUM GridViewSettings.GRID_AND_ZN_VIEW_ENUM |
r/w | The grid view setting. |
| horizontalScale | number | r/w | The horizontal scaling applied to the GridDataInformation. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| lineAki | number | r/w | The amount of white space between lines. |
| lineAlignment | LineAlignment: 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/w | The line justification. |
| parent | NamedGrid Page Story TextFrame XmlStory |
readonly | The parent of the GridDataInformation (a Story, XmlStory, Page, NamedGrid or TextFrame). |
| pointSize | Measurement Unit (Number or String) | r/w | The text size. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| verticalScale | number | r/w | The vertical scaling applied to the GridDataInformation. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the GridDataInformation.
Element of
NamedGrid.gridData
Page.gridData
Story.gridData
TextFrame.gridData
XmlStory.gridData
Return
Array of GridDataInformation GridDataInformation.getElements ()
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |