Adobe InDesign CS6 Server (8.0) Object Model JS: Font

InDesign Server CS6

Class

Font

 A font.

QuickLinks

addEventListener, checkOpenTypeFeature, createSubsetFont, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Font
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
allowEditableEmbeddingbool readonlyIf true, the font can be embedded.
allowOutlinesbool readonlyIf true, the font can be converted to outlines.
allowPDFEmbeddingbool readonlyIf true, the font can be embedded in a PDF document.
allowPrintingbool readonlyIf true, the can font be printed.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fontFamilystring readonlyThe name of the font family
fontStyleNamestring readonlyThe name of the font style.
fontStyleNameNativestring readonlyThe native name of the font style.
fontTypeFontTypes:
FontTypes.TYPE_1
FontTypes.TRUETYPE
FontTypes.CID
FontTypes.ATC
FontTypes.BITMAP
FontTypes.OCF
FontTypes.OPENTYPE_CFF
FontTypes.OPENTYPE_CID
FontTypes.OPENTYPE_TT
FontTypes.UNKNOWN
readonlyThe type of font.
fullNamestring readonlyThe full font name.
fullNameNativestring readonlyThe full native name of the font.
indexnumber readonlyThe index of the Font within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
locationstring readonlyThe full path to the Font.
namestring readonlyThe name of the Font.
orderingstring readonlyThe ordering of a CID font.
parentApplication
Document
readonlyThe parent of the Font (a Document or Application).
platformNamestring readonlyThe platform font name.
postscriptNamestring readonlyThe PostScript name of the font.
propertiesObject r/wA property that allows setting of several properties at the same time.
registrystring readonlyThe registry of a CID font.
restrictedPrintingbool readonlyIf true, the font allows only restricted printing.
statusFontStatus:
FontStatus.INSTALLED
FontStatus.NOT_AVAILABLE
FontStatus.FAUXED
FontStatus.SUBSTITUTED
FontStatus.UNKNOWN
readonlyThe status of the font.
versionstring readonlyThe font version.
writingScriptnumber readonlyThe writing script.

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)

bool checkOpenTypeFeature (using: varies)
Checks whether the font supports the specified OpenType feature.

ParameterTypeDescription
usingOpenTypeFeature
String
The OpenType feature to check for, specified either as an OpenType feature or a string. Can accept: OpenTypeFeature enumerator or String.

void createSubsetFont (charactersForSubset: string, fontDestination: File)
Create a copy of the font with just enough information to render the list of characters given.

ParameterTypeDescription
charactersForSubsetstringString with all the characters used in the resulting font.
fontDestinationFileFile location for the new font.

Array of Font getElements ()
Resolves the object specifier, creating an array of object references.

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 Font.

string toSpecifier ()
Retrieves the object specifier.

Element of

Bullet.bulletsFont

ChangeGlyphPreference.appliedFont

ChangeGrepPreference.appliedFont

ChangeGrepPreference.kentenFont

ChangeGrepPreference.rubyFont

ChangeTextPreference.appliedFont

ChangeTextPreference.kentenFont

ChangeTextPreference.rubyFont

ChangeTransliteratePreference.appliedFont

ChangeTransliteratePreference.kentenFont

ChangeTransliteratePreference.rubyFont

Character.appliedFont

Character.kentenFont

Character.rubyFont

CharacterStyle.appliedFont

CharacterStyle.kentenFont

CharacterStyle.rubyFont

CompositeFontEntry.appliedFont

FindGlyphPreference.appliedFont

FindGrepPreference.appliedFont

FindGrepPreference.kentenFont

FindGrepPreference.rubyFont

FindTextPreference.appliedFont

FindTextPreference.kentenFont

FindTextPreference.rubyFont

FindTransliteratePreference.appliedFont

FindTransliteratePreference.kentenFont

FindTransliteratePreference.rubyFont

GridDataInformation.appliedFont

InsertionPoint.appliedFont

InsertionPoint.kentenFont

InsertionPoint.rubyFont

LayoutGridDataInformation.appliedFont

Line.appliedFont

Line.kentenFont

Line.rubyFont

Paragraph.appliedFont

Paragraph.kentenFont

Paragraph.rubyFont

ParagraphStyle.appliedFont

ParagraphStyle.kentenFont

ParagraphStyle.rubyFont

Story.appliedFont

Story.kentenFont

Story.rubyFont

StoryGridDataInformation.appliedFont

Text.appliedFont

Text.kentenFont

Text.rubyFont

TextColumn.appliedFont

TextColumn.kentenFont

TextColumn.rubyFont

TextDefault.appliedFont

TextDefault.kentenFont

TextDefault.rubyFont

TextStyleRange.appliedFont

TextStyleRange.kentenFont

TextStyleRange.rubyFont

Word.appliedFont

Word.kentenFont

Word.rubyFont

XmlStory.appliedFont

XmlStory.kentenFont

XmlStory.rubyFont

Used in:

Font Fonts.nextItem (obj: Font)

Font Fonts.previousItem (obj: Font)

Return

Array of Font Font.getElements ()

Font Fonts.[] (index: number)

Font Fonts.anyItem ()

Array of Font Fonts.everyItem ()

Font Fonts.firstItem ()

Font Fonts.item (index: varies)

Font Fonts.itemByName (name: string)

Array of Font Fonts.itemByRange (from: varies, to: varies)

Font Fonts.lastItem ()

Font Fonts.middleItem ()

Font Fonts.nextItem (obj: Font)

Font Fonts.previousItem (obj: Font)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index