LinkingPreference

Linking preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, LinkResourceRenditionType, Object

Hierarchy:

Superclass: Preference

Class: LinkingPreference

Property Listing

Property

Type

Access

Description

checkLinksAtOpen

Boolean

read/write

If true, link states will be checked at document open time

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

findMissingLinksAtOpen

Boolean

read/write

If true, missing links will be searched for at document open time

httpLinksAutoTagAssetsPreference

Boolean

read/write

Experimental: The preference for enabling auto tagging of items created through http based links.

httpLinksRenditionType

LinkResourceRenditionType

LinkResourceRenditionType.ACTUAL

LinkResourceRenditionType.FPO

read/write

Experimental: The rendition type for http link.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Application

readonly

The parent of the LinkingPreference (a Application).

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.linkingPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

LinkingPreference.getElements()