TextParagraphStyles

A collection of paragraph styles.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
 → ParagraphStyle
count(
)
 → number
item(
index)
 → ParagraphStyle
itemByName(
name)
 → ParagraphStyle
itemByRange(
from, to)
 → ParagraphStyle
nextItem(
obj)
 → ParagraphStyle
toSource(
)
 → string
add(
[withProperties])
 → ParagraphStyle
Creates a new ParagraphStyle.
withProperties Object Initial values for properties of the new ParagraphStyle (Optional)
anyItem(
)
 → ParagraphStyle
Returns any ParagraphStyle in the collection.
count(
)
 → number
Displays the number of elements in the ParagraphStyle.
everyItem(
)
 → ParagraphStyle
Returns every ParagraphStyle in the collection.
firstItem(
)
 → ParagraphStyle
Returns the first ParagraphStyle in the collection.
item(
index)
 → ParagraphStyle
Returns the ParagraphStyle with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
 → ParagraphStyle
Returns the ParagraphStyle with the specified ID.
id number The ID.
itemByName(
name)
 → ParagraphStyle
Returns the ParagraphStyle with the specified name.
name string The name.
itemByRange(
from, to)
 → ParagraphStyle
Returns the ParagraphStyles within the specified range.
from The ParagraphStyle, index, or name at the beginning of the range. Can accept: ParagraphStyle, Long Integer or String.
to The ParagraphStyle, index, or name at the end of the range. Can accept: ParagraphStyle, Long Integer or String.
lastItem(
)
 → ParagraphStyle
Returns the last ParagraphStyle in the collection.
middleItem(
)
 → ParagraphStyle
Returns the middle ParagraphStyle in the collection.
nextItem(
obj)
 → ParagraphStyle
Returns the ParagraphStyle whose index follows the specified ParagraphStyle in the collection.
obj ParagraphStyle The ParagraphStyle whose index comes before the desired ParagraphStyle.
previousItem(
obj)
 → ParagraphStyle
Returns the ParagraphStyle with the index previous to the specified index.
obj ParagraphStyle The index of the ParagraphStyle that follows the desired ParagraphStyle.
toSource(
)
 → string
Generates a string which, if executed, will return the ParagraphStyle.