Object

Bookmark

A bookmark.

Hierarchy

Bookmark

Properties

Type	Access	Description
Bookmarks<Bookmark>	readonly	A collection of bookmarks.
HyperlinkExternalPageDestination \| HyperlinkPageDestination \| HyperlinkTextDestination \| Page	readonly	The destination that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page.
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Number	readonly	The unique ID of the Bookmark.
Number	readonly	The indent level of the bookmark.
Number	readonly	The index of the Bookmark within its containing object.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
String	read/write	The name of the Bookmark.
Bookmark \| Document	readonly	The parent of the Bookmark (a Document or Bookmark).
Object	read/write	A property that allows setting of several properties at the same time.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ String

Gets the label value associated with the specified key.

key String The key.

→ Bookmark[]

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

→ void

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

key String The key.

value String The value.

→ Bookmark

Moves the bookmark to the specified location.

to? LocationOptions The bookmark location relative to the reference object or within the containing object.

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

→ void

Deletes the Bookmark.

→ Boolean

Removes the event listener.

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.

→ void

Go to the bookmark.

→ String

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

→ String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a Bookmark.

Bookmark.parent Event.parent EventListener.parent GotoAnchorBehavior.anchorItem MutationEvent.parent

Parameter of 4

Method parameters that accept a Bookmark.

Bookmark.move(reference)Bookmarks.itemByRange(from)Bookmarks.nextItem(obj)Bookmarks.previousItem(obj)

Return 15

Methods that return a Bookmark.

Bookmark.getElements()Bookmark.move()Bookmarks.[]()Bookmarks.add()Bookmarks.anyItem()Bookmarks.everyItem()Bookmarks.firstItem()Bookmarks.item()Bookmarks.itemByID()Bookmarks.itemByName()Bookmarks.itemByRange()Bookmarks.lastItem()Bookmarks.middleItem()Bookmarks.nextItem()Bookmarks.previousItem()