K4 InDesign Javascript API Documentation

PreferencesLinkedPageItemOption

The link options for a linked Page Item.

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The 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, TextFrame or EndnoteTextFrame). read-only
preserveAppearance bool If true, appearance edits will be preserved during update. read-write
preserveFrameContent bool If true, frame content edits will be preserved during update. read-write
preserveInteractivity bool If true, interactivity edits will be preserved during update. read-write
preserveOthers bool If true, text wrap, hyperLinks, text frame options, object export settings will be preserved during update. read-write
preserveSizeAndShape bool If true, size and shape edits will be preserved during update. read-write
properties Object A property that allows setting of several properties at the same time. read-write
updateLinkWhileSaving bool If true, the linked Page Item will be updated while saving. read-write
warnOnUpdateOfEditedPageItem bool If true, a warning will be shown if the update link operation will override local edits. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → LinkedPageItemOption
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → LinkedPageItemOption
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the LinkedPageItemOption.
toSpecifier(
)
  → string
Retrieves the object specifier.