Adobe InCopy CS5 (7.0) Object Model JS: Preference

InCopy CS5

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

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
Preference
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 | XMLViewPreference
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.
parentApplicationButton
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
readonlyThe 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).
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