Page.getBookmarks (Method)
Returns zero or more structures, each containing information on an element's bookmarks contained within a page. If the bookmark is contained inside a RTE, it is not returned.
Returns:
Page_GetBookmarks_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Bookmark | PlainText_NonNull_255 | The bookmark. |
| ElementID | ControlID | The ID of the element instance on which the bookmark was created. |
| ElementTypeID | ElementTypeID_0 | The ID of the element type on which the bookmark was created or 0 for top of the page. |
| Name | PlainText_NonNull_255 | The bookmark's name. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | RealPageID_NonBaseTemplate | Required | A page's ID. |
| namedBookmarksOnly | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that CommonSpot only returns user-named bookmarks. |
| includeTemplates | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot includes bookmarks from the page's templates. |
Context:
| License Requirements | None |
| Permission Requirements | (none) |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the site level |
Error Codes:
None
Notes:
None