Preference

A preferences object.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object,

Hierarchy:

Class: Preference

Subclasses: PlaceGun | ScriptArg | ContentPlacerObject | IndexOptions | TimingSetting | PDFAttribute | FrameFittingOption | TextWrapPreference | ContourOption | TransformAttributeOption | LinkMetadata | StoryPreference | TextFramePreference | TextPreference | TextDefault | DocumentPreference | GridPreference | GuidePreference | MarginPreference | PasteboardPreference | ViewPreference | PrintPreference | PrintBookletOption | PrintBookletPrintPreference | EPSExportPreference | ToolBox | ImagePreference | ImageIOPreference | ClippingPathSettings | GraphicLayerOption | IMEPreference | PDFExportPreference | PDFPlacePreference | InteractivePDFExportPreference | TaggedPDFPreference | EndnoteOption | FontSyncPreference | PageItemDefault | ObjectExportOption | TextEditingPreference | MojikumiUiPreference | FontLockingPreference | DictionaryPreference | PolygonPreference | SpellPreference | AutoCorrectPreference | SmartGuidePreference | EPSImportPreference | ImportedPageAttribute | StrokeFillProxySetting | AdjustLayoutPreference | ScriptPreference | ColorSetting | FindChangeTextOption | FindChangeGrepOption | FindChangeGlyphOption | FindChangeObjectOption | FindChangeTransliterateOption | FindTextPreference | FindGrepPreference | FindGlyphPreference | FindObjectPreference | FindTransliteratePreference | ChangeTextPreference | ChangeGrepPreference | ChangeGlyphPreference | ChangeObjectPreference | ChangeTransliteratePreference | FindChangeColorOption | FindColorPreference | ChangeColorPreference | LinkingPreference | InCopyExportOption | XMLImportPreference | XMLExportPreference | XMLPreference | ExportForWebPreference | AnchoredObjectDefault | AnchoredObjectSetting | BaselineFrameGridOption | FootnoteOption | PageNumberVariablePreference | ChapterNumberVariablePreference | DateVariablePreference | FileNameVariablePreference | MatchCharacterStylePreference | MatchParagraphStylePreference | CustomTextVariablePreference | CaptionMetadataVariablePreference | GridDataInformation | LayoutGridDataInformation | StoryGridDataInformation | CjkGridPreference | GridPrintingPreference | GalleyPreference | FlattenerPreference | TransparencyPreference | TransparencySetting | StrokeTransparencySetting | FillTransparencySetting | BlendingSetting | DropShadowSetting | FeatherSetting | InnerShadowSetting | OuterGlowSetting | InnerGlowSetting | BevelAndEmbossSetting | SatinSetting | ContentTransparencySetting | DirectionalFeatherSetting | GradientFeatherSetting | FindChangeTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeFillTransparencySetting | FindChangeContentTransparencySetting | TextImportPreference | TextExportPreference | WordRTFImportPreference | TaggedTextExportPreference | TaggedTextImportPreference | ExcelImportPreference | MetadataPreference | DisplayPerformancePreference | GpuPerformancePreference | XMLViewPreference | PreflightOption | PreflightBookOption | PNGExportPreference | ButtonPreference | WatermarkPreference | GeneralPreference | ClipboardPreference | TransformPreference | NotePreference | TrackChangesPreference | JPEGExportPreference | DataMergePreference | DataMergeOption | DataMerge | ChapterNumberPreference | ObjectStyleObjectEffectsCategorySettings | ObjectStyleStrokeEffectsCategorySettings | ObjectStyleFillEffectsCategorySettings | ObjectStyleContentEffectsCategorySettings | GrabberPreference | TypeContextualUiPreference | AlignDistributePreference | AnimationSetting | ConditionalTextPreference | EPubExportPreference | HTMLExportPreference | EPubFixedLayoutExportPreference | EPubExportPreviewAppPreference | HTMLFXLExportPreference | PublishExportPreference | LinkedStoryOption | LinkedPageItemOption | Bullet | NumberingRestartPolicy

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Book

Button

ChangeGrepPreference

ChangeObjectPreference

ChangeTextPreference

Character

CheckBox

ComboBox

ContentTransparencySetting

DataMerge

Document

EPS

EPSText

EndnoteTextFrame

FillTransparencySetting

FindChangeContentTransparencySetting

FindChangeFillTransparencySetting

FindChangeStrokeTransparencySetting

FindChangeTransparencySetting

FindGrepPreference

FindObjectPreference

FindTextPreference

FindTransliteratePreference

FormField

Graphic

GraphicLine

Group

HtmlItem

Image

ImportedPage

InsertionPoint

Line

Link

ListBox

MasterSpread

MediaItem

Movie

MultiStateObject

NamedGrid

ObjectStyle

Oval

PDF

PICT

Page

PageItem

PageItemDefault

Paragraph

ParagraphStyle

Polygon

RadioButton

Rectangle

SVG

SignatureField

Sound

SplineItem

Spread

Story

StrokeTransparencySetting

Text

TextBox

TextColumn

TextDefault

TextFrame

TextStyleRange

TextVariable

TextWrapPreference

TransparencySetting

WMF

Word

XmlStory

Application

ChangeTransliteratePreference

readonly

The parent of the Preference (a Application, Document, Book, DataMerge, XmlStory, Spread, FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, FindChangeFillTransparencySetting, FindChangeContentTransparencySetting, HtmlItem, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, FormField, Sound, Movie, MediaItem, EPSText, Polygon, GraphicLine, Rectangle, Oval, SplineItem, SVG, ImportedPage, PICT, WMF, PDF, EPS, Image, Graphic, Group, EndnoteTextFrame, TextFrame, PageItem, PageItemDefault, TransparencySetting, StrokeTransparencySetting, FillTransparencySetting, ContentTransparencySetting, FindObjectPreference, ChangeObjectPreference, Story, TextVariable, TextWrapPreference, Page, Link, ObjectStyle, MasterSpread, NamedGrid, TextDefault, ParagraphStyle, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Text, FindTextPreference, ChangeTextPreference, FindGrepPreference, ChangeGrepPreference, FindTransliteratePreference or ChangeTransliteratePreference).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

Preference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the Preference.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

Preference.getElements()

Preferences.anyItem()

Preferences.everyItem()

Preferences.nextItem()

Preferences.previousItem()

Preferences.item()

Preferences.[]()

Preferences.itemByRange()

Preferences.firstItem()

Preferences.lastItem()

Preferences.middleItem()