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

InDesign Server CS5

Class

Preference

 

A preferences object.

Superclass of AlignDistributePreference, AnchoredObjectDefault, AnchoredObjectSetting, AnimationSetting, AutoCorrectPreference, BaselineFrameGridOption, BevelAndEmbossSetting, BlendingSetting, Bullet, ButtonPreference, CaptionMetadataVariablePreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeObjectPreference, ChangeTextPreference, ChangeTransliteratePreference, ChapterNumberPreference, ChapterNumberVariablePreference, CjkGridPreference, ClipboardPreference, ClippingPathSettings, ColorSetting, ConditionalTextPreference, ContentTransparencySetting, ContourOption, CustomTextVariablePreference, DataMerge, DataMergeOption, DataMergePreference, DateVariablePreference, DictionaryPreference, DirectionalFeatherSetting, DocumentPreference, DropShadowSetting, EPSExportPreference, EPSImportPreference, ExcelImportPreference, ExportForWebPreference, FeatherSetting, FileNameVariablePreference, FillTransparencySetting, FindChangeContentTransparencySetting, FindChangeFillTransparencySetting, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeStrokeTransparencySetting, FindChangeTextOption, FindChangeTransliterateOption, FindChangeTransparencySetting, FindGlyphPreference, FindGrepPreference, FindObjectPreference, FindTextPreference, FindTransliteratePreference, FlattenerPreference, FontLockingPreference, FootnoteOption, FrameFittingOption, GeneralPreference, GradientFeatherSetting, GraphicLayerOption, GridDataInformation, GridPreference, GridPrintingPreference, GuidePreference, ImageIOPreference, ImagePreference, ImportedPageAttribute, InCopyExportOption, IndexOptions, InnerGlowSetting, InnerShadowSetting, InteractivePDFExportPreference, JPEGExportPreference, LayoutAdjustmentPreference, LayoutGridDataInformation, LinkMetadata, LinkingPreference, MarginPreference, MatchCharacterStylePreference, MatchParagraphStylePreference, MetadataPreference, MojikumiUiPreference, NumberingRestartPolicy, ObjectStyleContentEffectsCategorySettings, ObjectStyleFillEffectsCategorySettings, ObjectStyleObjectEffectsCategorySettings, ObjectStyleStrokeEffectsCategorySettings, OuterGlowSetting, PDFAttribute, PDFExportPreference, PDFPlacePreference, PageItemDefault, PageNumberVariablePreference, PasteboardPreference, PlaceGun, PolygonPreference, PreflightBookOption, PreflightOption, PrintBookletOption, PrintBookletPrintPreference, PrintPreference, SWFExportPreference, SatinSetting, ScriptArg, ScriptPreference, ServerSetting, SpellPreference, StoryGridDataInformation, StoryPreference, StrokeTransparencySetting, TaggedTextExportPreference, TaggedTextImportPreference, TextDefault, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TextWrapPreference, TimingSetting, TrackChangesPreference, TransformPreference, TransparencyPreference, TransparencySetting, ViewPreference, WatermarkPreference, WordRTFImportPreference, XFLExportPreference, XMLExportPreference, XMLImportPreference, and XMLPreference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Book | Button | ChangeGrepPreference | ChangeObjectPreference | ChangeTextPreference | ChangeTransliteratePreference | Character | ContentTransparencySetting | DataMerge | Document | EPS | EPSText | FillTransparencySetting | FindChangeContentTransparencySetting | FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeTransparencySetting | FindGrepPreference | FindObjectPreference | FindTextPreference | FindTransliteratePreference | FormField | Graphic | GraphicLine | Group | Image | ImportedPage | InsertionPoint | Line | Link | MasterSpread | MediaItem | Movie | MultiStateObject | NamedGrid | ObjectStyle | Oval | Page | PageItem | PageItemDefault | Paragraph | ParagraphStyle | PDF | PICT | Polygon | Rectangle | Sound | SplineItem | Spread | Story | StrokeTransparencySetting | Text | TextColumn | TextDefault | TextFrame | TextStyleRange | TextVariable | TextWrapPreference | TransparencySetting | WMF | Word | XmlStory
Preference
AlignDistributePreference | AnchoredObjectDefault | AnchoredObjectSetting | AnimationSetting | AutoCorrectPreference | BaselineFrameGridOption | BevelAndEmbossSetting | BlendingSetting | Bullet | ButtonPreference | CaptionMetadataVariablePreference | ChangeGlyphPreference | ChangeGrepPreference | ChangeObjectPreference | ChangeTextPreference | ChangeTransliteratePreference | ChapterNumberPreference | ChapterNumberVariablePreference | CjkGridPreference | ClipboardPreference | ClippingPathSettings | ColorSetting | ConditionalTextPreference | ContentTransparencySetting | ContourOption | CustomTextVariablePreference | DataMerge | DataMergeOption | DataMergePreference | DateVariablePreference | DictionaryPreference | DirectionalFeatherSetting | DocumentPreference | DropShadowSetting | EPSExportPreference | EPSImportPreference | ExcelImportPreference | ExportForWebPreference | FeatherSetting | FileNameVariablePreference | FillTransparencySetting | FindChangeContentTransparencySetting | FindChangeFillTransparencySetting | FindChangeGlyphOption | FindChangeGrepOption | FindChangeObjectOption | FindChangeStrokeTransparencySetting | FindChangeTextOption | FindChangeTransliterateOption | FindChangeTransparencySetting | FindGlyphPreference | FindGrepPreference | FindObjectPreference | FindTextPreference | FindTransliteratePreference | FlattenerPreference | FontLockingPreference | FootnoteOption | FrameFittingOption | GeneralPreference | GradientFeatherSetting | GraphicLayerOption | GridDataInformation | GridPreference | GridPrintingPreference | GuidePreference | ImageIOPreference | ImagePreference | ImportedPageAttribute | InCopyExportOption | IndexOptions | InnerGlowSetting | InnerShadowSetting | InteractivePDFExportPreference | JPEGExportPreference | LayoutAdjustmentPreference | LayoutGridDataInformation | LinkMetadata | LinkingPreference | MarginPreference | MatchCharacterStylePreference | MatchParagraphStylePreference | MetadataPreference | MojikumiUiPreference | NumberingRestartPolicy | ObjectStyleContentEffectsCategorySettings | ObjectStyleFillEffectsCategorySettings | ObjectStyleObjectEffectsCategorySettings | ObjectStyleStrokeEffectsCategorySettings | OuterGlowSetting | PDFAttribute | PDFExportPreference | PDFPlacePreference | PageItemDefault | PageNumberVariablePreference | PasteboardPreference | PlaceGun | PolygonPreference | PreflightBookOption | PreflightOption | PrintBookletOption | PrintBookletPrintPreference | PrintPreference | SWFExportPreference | SatinSetting | ScriptArg | ScriptPreference | ServerSetting | SpellPreference | StoryGridDataInformation | StoryPreference | StrokeTransparencySetting | TaggedTextExportPreference | TaggedTextImportPreference | TextDefault | TextExportPreference | TextFramePreference | TextImportPreference | TextPreference | TextWrapPreference | TimingSetting | TrackChangesPreference | TransformPreference | TransparencyPreference | TransparencySetting | ViewPreference | WatermarkPreference | WordRTFImportPreference | XFLExportPreference | XMLExportPreference | XMLImportPreference | XMLPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplicationBook
Button
ChangeGrepPreference
ChangeObjectPreference
ChangeTextPreference
ChangeTransliteratePreference
Character
ContentTransparencySetting
DataMerge
Document
EPS
EPSText
FillTransparencySetting
FindChangeContentTransparencySetting
FindChangeFillTransparencySetting
FindChangeStrokeTransparencySetting
FindChangeTransparencySetting
FindGrepPreference
FindObjectPreference
FindTextPreference
FindTransliteratePreference
FormField
Graphic
GraphicLine
Group
Image
ImportedPage
InsertionPoint
Line
Link
MasterSpread
MediaItem
Movie
MultiStateObject
NamedGrid
ObjectStyle
Oval
Page
PageItem
PageItemDefault
Paragraph
ParagraphStyle
PDF
PICT
Polygon
Rectangle
Sound
SplineItem
Spread
Story
StrokeTransparencySetting
Text
TextColumn
TextDefault
TextFrame
TextStyleRange
TextVariable
TextWrapPreference
TransparencySetting
WMF
Word
XmlStory
readonlyThe parent of the Preference (a Application, Document, XmlStory, Spread, FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, FindChangeFillTransparencySetting, FindChangeContentTransparencySetting, MultiStateObject, Button, FormField, Sound, Movie, MediaItem, EPSText, Polygon, GraphicLine, Rectangle, Oval, SplineItem, ImportedPage, PICT, WMF, PDF, EPS, Image, Graphic, Group, TextFrame, PageItem, PageItemDefault, TransparencySetting, StrokeTransparencySetting, FillTransparencySetting, ContentTransparencySetting, FindObjectPreference, ChangeObjectPreference, Story, TextVariable, TextWrapPreference, Page, Book, Link, ObjectStyle, MasterSpread, NamedGrid, TextDefault, ParagraphStyle, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Text, FindTextPreference, ChangeTextPreference, FindGrepPreference, ChangeGrepPreference, FindTransliteratePreference, ChangeTransliteratePreference or DataMerge).
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)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

Preference Preferences.nextItem (obj: Preference)

Preference Preferences.previousItem (obj: Preference)

Return

Array of Preference Preference.getElements ()

Preference Preferences.[] (index: number)

Preference Preferences.anyItem ()

Array of Preference Preferences.everyItem ()

Preference Preferences.firstItem ()

Preference Preferences.item (index: varies)

Array of Preference Preferences.itemByRange (from: varies, to: varies)

Preference Preferences.lastItem ()

Preference Preferences.middleItem ()

Preference Preferences.nextItem (obj: Preference)

Preference Preferences.previousItem (obj: Preference)

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