Adobe InCopy CS5 (7.0) Object Model JS: Preference

InCopy CS5

previous page next page

Class

Preference

A preferences object.

Superclass of AnchoredObjectDefault, AnchoredObjectSetting, AutoCorrectPreference, BaselineFrameGridOption, Bullet, CaptionMetadataVariablePreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeTextPreference, ChangeTransliteratePreference, ChapterNumberVariablePreference, ClipboardPreference, ClippingPathSettings, ConditionalTextPreference, ContourOption, CustomTextVariablePreference, DateVariablePreference, DictionaryPreference, DocumentPreference, ExcelImportPreference, ExportForWebPreference, FileNameVariablePreference, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeTextOption, FindChangeTransliterateOption, FindGlyphPreference, FindGrepPreference, FindTextPreference, FindTransliteratePreference, FootnoteOption, FrameFittingOption, GalleyPreference, GalleyPrintPreference, GeneralPreference, GraphicLayerOption, GridPreference, GuidePreference, IMEPreference, ImageIOPreference, ImagePreference, ImportedPageAttribute, InCopyExportOption, LayoutPrintPreference, LinkMetadata, LinkingPreference, MarginPreference, MatchCharacterStylePreference, MatchParagraphStylePreference, MetadataPreference, MojikumiUiPreference, NotePreference, NumberingRestartPolicy, PDFGalleyExportPreference, PDFLayoutExportPreference, PageItemDefault, PageNumberVariablePreference, PasteboardPreference, PlaceGun, ScriptArg, ScriptPreference, SpellPreference, StoryPreference, StrokeFillProxySetting, TaggedTextExportPreference, TaggedTextImportPreference, TextDefault, TextEditingPreference, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TextWrapPreference, ToolBox, TrackChangesPreference, ViewPreference, WordRTFImportPreference, XMLExportPreference, XMLImportPreference, XMLPreference, and XMLViewPreference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Preference

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
parent	Application Button ChangeGrepPreference ChangeTextPreference ChangeTransliteratePreference Character Document EPS EPSText FindGrepPreference FindTextPreference FindTransliteratePreference FormField Graphic GraphicLine Group Image ImportedPage InsertionPoint Line Link MediaItem Movie MultiStateObject Oval Page PageItem Paragraph ParagraphStyle PDF PICT Polygon Rectangle Sound SplineItem Story Text TextColumn TextDefault TextFrame TextStyleRange TextVariable TextWrapPreference WMF Word XmlStory	readonly	The parent of the Preference (a Application, Document, XmlStory, Story, TextFrame, TextVariable, EPSText, Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, Button, MultiStateObject, FormField, Sound, Movie, MediaItem, ImportedPage, PICT, WMF, PDF, EPS, Image, Graphic, PageItem, TextWrapPreference, Page, Link, TextDefault, ParagraphStyle, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Text, FindTextPreference, ChangeTextPreference, FindGrepPreference, ChangeGrepPreference, FindTransliteratePreference or ChangeTransliteratePreference).
properties	Object	r/w	A 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.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)