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

InDesign Server CS6

Class

LinkedPageItemOption

 The link options for a linked Page Item. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Button | CheckBox | ComboBox | Document | EPS | EPSText | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PageItem | PDF | PICT | Polygon | RadioButton | Rectangle | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF
Preference
LinkedPageItemOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplicationButton
CheckBox
ComboBox
Document
EPS
EPSText
FormField
Graphic
GraphicLine
Group
HtmlItem
Image
ImportedPage
ListBox
MediaItem
Movie
MultiStateObject
Oval
PageItem
PDF
PICT
Polygon
RadioButton
Rectangle
SignatureField
Sound
SplineItem
TextBox
TextFrame
WMF
readonlyThe parent of the LinkedPageItemOption (a Application, Document, PageItem, HtmlItem, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group or TextFrame).
preserveAppearancebool r/wIf true, appearance edits will be preserved during update.
preserveFrameContentbool r/wIf true, frame content edits will be preserved during update.
preserveInteractivitybool r/wIf true, interactivity edits will be preserved during update.
preserveOthersbool r/wIf true, text wrap, hyperLinks, text frame options, object export settings will be preserved during update.
preserveSizeAndShapebool r/wIf true, size and shape edits will be preserved during update.
propertiesObject r/wA property that allows setting of several properties at the same time.
updateLinkWhileSavingbool r/wIf true, the linked Page Item will be updated while saving.
warnOnUpdateOfEditedPageItembool r/wIf true, a warning will be shown if the update link operation will override local edits.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.linkedPageItemOptions

Button.linkedPageItemOptions

CheckBox.linkedPageItemOptions

ComboBox.linkedPageItemOptions

Document.linkedPageItemOptions

EPS.linkedPageItemOptions

EPSText.linkedPageItemOptions

FormField.linkedPageItemOptions

Graphic.linkedPageItemOptions

GraphicLine.linkedPageItemOptions

Group.linkedPageItemOptions

HtmlItem.linkedPageItemOptions

Image.linkedPageItemOptions

ImportedPage.linkedPageItemOptions

ListBox.linkedPageItemOptions

MediaItem.linkedPageItemOptions

Movie.linkedPageItemOptions

MultiStateObject.linkedPageItemOptions

Oval.linkedPageItemOptions

PDF.linkedPageItemOptions

PICT.linkedPageItemOptions

PageItem.linkedPageItemOptions

Polygon.linkedPageItemOptions

RadioButton.linkedPageItemOptions

Rectangle.linkedPageItemOptions

SignatureField.linkedPageItemOptions

Sound.linkedPageItemOptions

SplineItem.linkedPageItemOptions

TextBox.linkedPageItemOptions

TextFrame.linkedPageItemOptions

WMF.linkedPageItemOptions

Return

Array of LinkedPageItemOption LinkedPageItemOption.getElements ()

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