K4 InDesign Javascript API Documentation

TextCompositeFontEntries

A collection of composite font entries.

Instance Properties

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

Methods

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