Adobe InDesign CS6 (8.0) Object Model JS: NestedStyle

InDesign CS6

Class

NestedStyle

 A nested style.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Character | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextDefault | TextStyleRange | Word | XmlStory
NestedStyle
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
appliedCharacterStyleCharacterStyleString r/wThe character style applied to the text. Can also accept: String.
delimiterNestedStyleDelimiters
String
r/wThe delimiting expression that indicates how deeply into the paragraph the nested style is applied. Can return: String or NestedStyleDelimiters enumerator.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
inclusivebool r/wIf true, the nested style is applied through the last delimiter. If false, the nested style is applied up to the last delimiter.
indexnumber readonlyThe index of the NestedStyle within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentCharacter
InsertionPoint
Line
Paragraph
ParagraphStyle
Story
Text
TextColumn
TextDefault
TextStyleRange
Word
XmlStory
readonlyThe parent of the NestedStyle (a TextDefault, Paragraph, ParagraphStyle, Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, Story or XmlStory).
propertiesObject r/wA property that allows setting of several properties at the same time.
repetitionnumber r/wThe number instances of the specified delimiter up to which, or through which, to apply the nested style.

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 NestedStyle getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the NestedStyle.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

NestedStyle NestedStyles.nextItem (obj: NestedStyle)

NestedStyle NestedStyles.previousItem (obj: NestedStyle)

Return

Array of NestedStyle NestedStyle.getElements ()

NestedStyle NestedStyles.[] (index: number)

NestedStyle NestedStyles.add ([withProperties: Object])

NestedStyle NestedStyles.anyItem ()

Array of NestedStyle NestedStyles.everyItem ()

NestedStyle NestedStyles.firstItem ()

NestedStyle NestedStyles.item (index: varies)

Array of NestedStyle NestedStyles.itemByRange (from: varies, to: varies)

NestedStyle NestedStyles.lastItem ()

NestedStyle NestedStyles.middleItem ()

NestedStyle NestedStyles.nextItem (obj: NestedStyle)

NestedStyle NestedStyles.previousItem (obj: NestedStyle)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index