Bookmark

A bookmark.

Methods:

addEventListener, extractLabel, getElements, insertLabel, move, remove, removeEventListener, showBookmark, toSource, toSpecifier

Objects:

Bookmarks, Boolean, EventListeners, Events, HyperlinkExternalPageDestination, HyperlinkPageDestination, HyperlinkTextDestination, Number, Object, Page, String,

Property Listing

Property

Type

Access

Description

bookmarks

Bookmarks Bookmark

readonly

A collection of bookmarks.

destination

HyperlinkExternalPageDestination

HyperlinkPageDestination

HyperlinkTextDestination

Page

readonly

The destination that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the Bookmark.

indent

Number

readonly

The indent level of the bookmark.

index

Number

readonly

The index of the Bookmark within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the Bookmark.

parent

Bookmark

Document

readonly

The parent of the Bookmark (a Document or Bookmark).

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)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Bookmark getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter

Type

Description

key

String

The key.

value

String

The value.

Bookmark move ([to:LocationOptions=LocationOptions], reference:Varies Bookmark Document Bookmark)

Moves the bookmark to the specified location.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The bookmark location relative to the reference object or within the containing object. (Optional)

(default: LocationOptions.AT_END)

reference

Bookmark

Document

The reference object. Note: Required when the to parameter specifies before or after. Can accept: Bookmark, Document or Bookmark. (Optional)

undefined remove ()

Deletes the Bookmark.

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)

undefined showBookmark ()

Go to the bookmark.

String toSource ()

Generates a string which, if executed, will return the Bookmark.

String toSpecifier ()

Retrieves the object specifier.

Object of

GotoAnchorBehavior.anchorItem

Bookmark.parent

Event.parent

EventListener.parent

MutationEvent.parent

Return

Bookmarks.add()

Bookmark.move()

Bookmark.getElements()

Bookmarks.anyItem()

Bookmarks.everyItem()

Bookmarks.nextItem()

Bookmarks.previousItem()

Bookmarks.itemByID()

Bookmarks.item()

Bookmarks.[]()

Bookmarks.itemByName()

Bookmarks.itemByRange()

Bookmarks.firstItem()

Bookmarks.lastItem()

Bookmarks.middleItem()