CellStyleMappings

A collection of cell style mappings.

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

CellStyleMapping [] (index:Number)

Returns the CellStyleMapping with the specified index.

Parameter

Type

Description

index

Number

The index.

CellStyleMapping 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 CellStyleMapping (Optional)

CellStyleMapping anyItem ()

Returns any CellStyleMapping in the collection.

Number count ()

Displays the number of elements in the CellStyleMapping.

CellStyleMapping everyItem ()

Returns every CellStyleMapping in the collection.

CellStyleMapping firstItem ()

Returns the first CellStyleMapping in the collection.

CellStyleMapping item (index:Varies LongInteger String)

Returns the CellStyleMapping with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

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

Returns the CellStyleMappings within the specified range.

Parameter

Type

Description

from

CellStyleMapping

LongInteger

String

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

to

CellStyleMapping

LongInteger

String

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

CellStyleMapping lastItem ()

Returns the last CellStyleMapping in the collection.

CellStyleMapping middleItem ()

Returns the middle CellStyleMapping in the collection.

CellStyleMapping nextItem (obj:CellStyleMapping)

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

Parameter

Type

Description

obj

CellStyleMapping

The CellStyleMapping whose index comes before the desired CellStyleMapping.

CellStyleMapping previousItem (obj:CellStyleMapping)

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

Parameter

Type

Description

obj

CellStyleMapping

The index of the CellStyleMapping that follows the desired CellStyleMapping.

String toSource ()

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

Object of

Application.cellStyleMappings

Document.cellStyleMappings

Story.cellStyleMappings

XmlStory.cellStyleMappings