Skip to main content

TcxCustomDataController.IsBookmarkAvailable Method

Indicates whether there is a bookmark available (created by the SaveBookmark method).

Declaration

function IsBookmarkAvailable: Boolean; virtual;

Returns

Type
Boolean

Remarks

Use the IsBookmarkAvailable function to test whether the SaveBookmark method was used to create a bookmark and that the bookmark still exists. If the bookmark is available, you can jump to the record to which it refers using the GotoBookmark method.

A bookmark can be unavailable for the following reasons:

  • the SaveBookmark was not called

  • the bookmark was cleared explicitly by the ClearBookmark method

  • the bookmark was cleared implicitly when the record referred to by the bookmark was deleted

For more details on bookmarks, refer to the SaveBookmark description.

See Also