Adobe InDesign CS6 Server (8.0) Object Model JS: CharStyleMapping

InDesign Server CS6

Class

CharStyleMapping

 A char style mapping.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | Story | XmlStory
CharStyleMapping
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
destinationStyleNamestring r/wThe destination style name property.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
indexnumber readonlyThe index of the CharStyleMapping within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
mappingRuleTypeMapType:
MapType.STYLE_MAPPING_RULE
MapType.GROUP_MAPPING_RULE
MapType.STYLE_TO_GROUP_MAPPING_RULE
MapType.GROUP_TO_STYLE_MAPPING_RULE
r/wThe type of the mapping rule.
parentApplication
Document
Story
XmlStory
readonlyThe parent of the CharStyleMapping (a Application, Document, Story or XmlStory).
propertiesObject r/wA property that allows setting of several properties at the same time.
sourceStyleNamestring r/wThe source style name property.

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

void remove ()
deletes a style mapping.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

CharStyleMapping CharStyleMappings.nextItem (obj: CharStyleMapping)

CharStyleMapping CharStyleMappings.previousItem (obj: CharStyleMapping)

Return

Array of CharStyleMapping CharStyleMapping.getElements ()

CharStyleMapping CharStyleMappings.[] (index: number)

CharStyleMapping CharStyleMappings.add (sourceStyleName: string, destinationStyleName: string, mappingRuleType: MapType[, withProperties: Object])

CharStyleMapping CharStyleMappings.anyItem ()

Array of CharStyleMapping CharStyleMappings.everyItem ()

CharStyleMapping CharStyleMappings.firstItem ()

CharStyleMapping CharStyleMappings.item (index: varies)

Array of CharStyleMapping CharStyleMappings.itemByRange (from: varies, to: varies)

CharStyleMapping CharStyleMappings.lastItem ()

CharStyleMapping CharStyleMappings.middleItem ()

CharStyleMapping CharStyleMappings.nextItem (obj: CharStyleMapping)

CharStyleMapping CharStyleMappings.previousItem (obj: CharStyleMapping)

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