ParaStyleMappings

A collection of para 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

ParaStyleMapping [] (index:Number)

Returns the ParaStyleMapping with the specified index.

Parameter	Type	Description
index	Number	The index.

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

ParaStyleMapping anyItem ()

Returns any ParaStyleMapping in the collection.

Number count ()

Displays the number of elements in the ParaStyleMapping.

ParaStyleMapping everyItem ()

Returns every ParaStyleMapping in the collection.

ParaStyleMapping firstItem ()

Returns the first ParaStyleMapping in the collection.

ParaStyleMapping item (index:Varies LongInteger String)

Returns the ParaStyleMapping 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.

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

Returns the ParaStyleMappings within the specified range.

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

Parameter

Type

Description

from

LongInteger

ParaStyleMapping

String

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

LongInteger

ParaStyleMapping

String

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

ParaStyleMapping lastItem ()

Returns the last ParaStyleMapping in the collection.

ParaStyleMapping middleItem ()

Returns the middle ParaStyleMapping in the collection.

ParaStyleMapping nextItem (obj:ParaStyleMapping)

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

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

ParaStyleMapping previousItem (obj:ParaStyleMapping)

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

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

String toSource ()

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

Object of

Application.paraStyleMappings

Document.paraStyleMappings

Story.paraStyleMappings

XmlStory.paraStyleMappings