CharStyleMappings
QuickLinks
Properties
Property | Type | Access | Description |
---|---|---|---|
length | number | readonly | The number of objects in the collection. |
Methods
Instances
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.STYLE_MAPPING_RULE MapType.GROUP_MAPPING_RULE MapType.STYLE_TO_GROUP_MAPPING_RULE MapType.GROUP_TO_STYLE_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.
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.
Parameter | Type | Description |
---|---|---|
index | Long 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.
Parameter | Type | Description |
---|---|---|
from | CharStyleMapping Long Integer String | The CharStyleMapping, index, or name at the beginning of the range. Can accept: CharStyleMapping, Long Integer or String. |
to | CharStyleMapping 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.
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.
Element of
Application.charStyleMappings
Document.charStyleMappings
Story.charStyleMappings
XmlStory.charStyleMappings
Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |