Class

RingStyle

 Ring style

QuickLinks

extractLabel, getElements, insertLabel, toSource, toSpecifier

Hierarchy

Application | Document

RingStyle

Properties

Property	Type	Access	Description
id	number	readonly	The unique ID of the RingStyle.
index	number	readonly	The index of the RingStyle within its containing object.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the RingStyle.
parent	ApplicationDocument	readonly	The parent of the RingStyle (a Application or Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
ringStyleGraphicUid	PageItem	r/w	Ring style graphic uid
ringStyleInnerRect	Array of number	r/w	Ring style inner rect
ringStyleMaxDigits	number	r/w	Ring style max digits
ringStyleOuterRect	Array of number	r/w	Ring style outer rect

Methods

Instances

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of RingStyle getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Character.endOfAyahRingStyle

InsertionPoint.endOfAyahRingStyle

Line.endOfAyahRingStyle

Paragraph.endOfAyahRingStyle

Text.endOfAyahRingStyle

TextColumn.endOfAyahRingStyle

TextStyleRange.endOfAyahRingStyle

Word.endOfAyahRingStyle

Used in:

array of RingStyle RingStyles.itemByRange (from: any, to: any)

RingStyle RingStyles.nextItem (obj: RingStyle)

RingStyle RingStyles.previousItem (obj: RingStyle)

Return

Array of RingStyle RingStyle.getElements ()

RingStyle RingStyles.add (name: string[, withProperties: Object])

RingStyle RingStyles.anyItem ()

Array of RingStyle RingStyles.everyItem ()

RingStyle RingStyles.firstItem ()

RingStyle RingStyles.item (index: any)

RingStyle RingStyles.itemByID (id: number)

RingStyle RingStyles.itemByName (name: string)

Array of RingStyle RingStyles.itemByRange (from: any, to: any)

RingStyle RingStyles.lastItem ()

RingStyle RingStyles.middleItem ()

RingStyle RingStyles.nextItem (obj: RingStyle)

RingStyle RingStyles.previousItem (obj: RingStyle)

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index