CharStyleMappings

A collection of char style mappings.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

CharStyleMapping [] (index:Number)

Returns the CharStyleMapping with the specified index.

Parameter	Type	Description
index	Number	The index.

CharStyleMapping add (sourceStyleName:String, destinationStyleName:String, mappingRuleType:MapType, withProperties:Object)

Adds a style mapping.

Parameter	Type	Description
sourceStyleName	String	The source style name.
destinationStyleName	String	The destination style name.
mappingRuleType	MapType MapType.GROUP_MAPPING_RULE MapType.GROUP_TO_STYLE_MAPPING_RULE MapType.STYLE_MAPPING_RULE MapType.STYLE_TO_GROUP_MAPPING_RULE	The mapping type
withProperties	Object	Initial values for properties of the new CharStyleMapping (Optional)

CharStyleMapping anyItem ()

Returns any CharStyleMapping in the collection.

Number count ()

Displays the number of elements in the CharStyleMapping.

CharStyleMapping everyItem ()

Returns every CharStyleMapping in the collection.

CharStyleMapping firstItem ()

Returns the first CharStyleMapping in the collection.

CharStyleMapping item (index:Varies LongInteger String)

Returns the CharStyleMapping with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

CharStyleMapping itemByRange (from:Varies CharStyleMapping LongInteger String, to:Varies CharStyleMapping LongInteger String)

Returns the CharStyleMappings within the specified range.

Parameter	Type	Description
from	CharStyleMapping LongInteger String	The CharStyleMapping, index, or name at the beginning of the range. Can accept: CharStyleMapping, Long Integer or String.
to	CharStyleMapping LongInteger String	The CharStyleMapping, index, or name at the end of the range. Can accept: CharStyleMapping, Long Integer or String.

Parameter

Type

Description

from

CharStyleMapping

LongInteger

String

The CharStyleMapping, index, or name at the beginning of the range. Can accept: CharStyleMapping, Long Integer or String.

CharStyleMapping

LongInteger

String

The CharStyleMapping, index, or name at the end of the range. Can accept: CharStyleMapping, Long Integer or String.

CharStyleMapping lastItem ()

Returns the last CharStyleMapping in the collection.

CharStyleMapping middleItem ()

Returns the middle CharStyleMapping in the collection.

CharStyleMapping nextItem (obj:CharStyleMapping)

Returns the CharStyleMapping whose index follows the specified CharStyleMapping in the collection.

Parameter	Type	Description
obj	CharStyleMapping	The CharStyleMapping whose index comes before the desired CharStyleMapping.

CharStyleMapping previousItem (obj:CharStyleMapping)

Returns the CharStyleMapping with the index previous to the specified index.

Parameter	Type	Description
obj	CharStyleMapping	The index of the CharStyleMapping that follows the desired CharStyleMapping.

String toSource ()

Generates a string which, if executed, will return the CharStyleMapping.

Object of

Application.charStyleMappings

Document.charStyleMappings

Story.charStyleMappings

XmlStory.charStyleMappings