Class

CharStyleMapping

A char style mapping.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document | Story | XmlStory

CharStyleMapping

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
destinationStyleName	string	r/w	The destination style name property.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
index	number	readonly	The index of the CharStyleMapping within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
mappingRuleType	MapType: MapType.STYLE_MAPPING_RULE MapType.GROUP_MAPPING_RULE MapType.STYLE_TO_GROUP_MAPPING_RULE MapType.GROUP_TO_STYLE_MAPPING_RULE	r/w	The type of the mapping rule.
parent	Application Document Story XmlStory	readonly	The parent of the CharStyleMapping (a Application, Document, Story or XmlStory).
properties	Object	r/w	A property that allows setting of several properties at the same time.
sourceStyleName	string	r/w	The source style name property.

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

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 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.3i

Contents :: Index