Adobe InDesign CS5 Server (7.0) Object Model JS: CompositeFont

InDesign Server CS5

Class

CompositeFont

 A composite font.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
CompositeFont
CompositeFontEntry | Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
compositeFontEntriesCompositeFontEntries readonlyA collection of composite font entries.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the CompositeFont.
indexnumber readonlyThe index of the CompositeFont within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the CompositeFont.
parentApplicationDocument readonlyThe parent of the CompositeFont (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

ParameterTypeDescription
keystringThe key.

Array of CompositeFont 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the CompositeFont.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

CompositeFontEntry.parent

Used in:

CompositeFont CompositeFonts.nextItem (obj: CompositeFont)

CompositeFont CompositeFonts.previousItem (obj: CompositeFont)

Return

Array of CompositeFont CompositeFont.getElements ()

CompositeFont CompositeFonts.[] (index: number)

CompositeFont CompositeFonts.add ([withProperties: Object])

CompositeFont CompositeFonts.anyItem ()

Array of CompositeFont CompositeFonts.everyItem ()

CompositeFont CompositeFonts.firstItem ()

CompositeFont CompositeFonts.item (index: varies)

CompositeFont CompositeFonts.itemByID (id: number)

CompositeFont CompositeFonts.itemByName (name: string)

Array of CompositeFont CompositeFonts.itemByRange (from: varies, to: varies)

CompositeFont CompositeFonts.lastItem ()

CompositeFont CompositeFonts.middleItem ()

CompositeFont CompositeFonts.nextItem (obj: CompositeFont)

CompositeFont CompositeFonts.previousItem (obj: CompositeFont)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index