K4 InDesign Javascript API Documentation

TextCompositeFontEntry

A composite font entry.

Instance Properties

Name Description Access
appliedFont The font applied to the CompositeFontEntry, specified as either a font object or the name of font family. Can return: Font or String. read-write
baselineShift number The amount of baseline shift. read-write
customCharacters string The characters that the set affects. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fontStyle string The name of the font style. read-write
horizontalScale number The horizontal scaling applied to the CompositeFontEntry. read-write
id number The unique ID of the CompositeFontEntry. read-only
index number The index of the CompositeFontEntry within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
locked bool If true, the CompositeFontEntry is locked. read-only
name string The name of the CompositeFontEntry. read-write
parent CompositeFont The parent of the CompositeFontEntry (a CompositeFont). read-only
properties Object A property that allows setting of several properties at the same time. read-write
relativeSize number The size of the entry relative to the base entry. Note: The base entry cannot be modified. read-write
scaleOption bool If true, scales characters from the center. read-write
verticalScale number The vertical scaling applied to the CompositeFontEntry. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → CompositeFontEntry
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → CompositeFontEntry
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the CompositeFontEntry.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the CompositeFontEntry.
toSpecifier(
)
  → string
Retrieves the object specifier.