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

InDesign Server CS6

Class

CharStyleMappings

 A collection of char style mappings.

See also CharStyleMapping.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

CharStyleMapping [] (index: number)
Returns the CharStyleMapping with the specified index.

ParameterTypeDescription
indexnumberThe index.

CharStyleMapping add (sourceStyleName: string, destinationStyleName: string, mappingRuleType: MapType[, withProperties: Object])
Adds a style mapping.

ParameterTypeDescription
sourceStyleNamestringThe source style name.
destinationStyleNamestringThe destination style name.
mappingRuleTypeMapType:
MapType.STYLE_MAPPING_RULE
MapType.GROUP_MAPPING_RULE
MapType.STYLE_TO_GROUP_MAPPING_RULE
MapType.GROUP_TO_STYLE_MAPPING_RULE
The mapping type
withPropertiesObjectInitial 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.

Array of CharStyleMapping everyItem ()
Returns every CharStyleMapping in the collection.

CharStyleMapping firstItem ()
Returns the first CharStyleMapping in the collection.

CharStyleMapping item (index: varies)
Returns the CharStyleMapping with the specified index or name.

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

Array of CharStyleMapping itemByRange (from: varies, to: varies)
Returns the CharStyleMappings within the specified range.

ParameterTypeDescription
fromCharStyleMapping
Long Integer
String
The CharStyleMapping, index, or name at the beginning of the range. Can accept: CharStyleMapping, Long Integer or String.
toCharStyleMapping
Long Integer
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.

ParameterTypeDescription
objCharStyleMappingThe CharStyleMapping whose index comes before the desired CharStyleMapping.

CharStyleMapping previousItem (obj: CharStyleMapping)
Returns the CharStyleMapping with the index previous to the specified index.

ParameterTypeDescription
objCharStyleMappingThe index of the CharStyleMapping that follows the desired CharStyleMapping.

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

Element of

Application.charStyleMappings

Document.charStyleMappings

Story.charStyleMappings

XmlStory.charStyleMappings

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