TextCharacterStyles

A collection of character styles.

Instance Properties

Name Description Access
length The number of objects in the collection. Can return: Long Integer or NothingEnum enumerator. read-only

Methods

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