GetDefinition Method (Bookmark)

In This Topic

Returns the CIM definition of the bookmark. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public CIMBookmark GetDefinition()

Public Function GetDefinition() As CIMBookmark

Return Value

The definition of the bookmark.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Example

Update Extent for a Bookmark

public Task UpdateBookmarkExtentAsync(Bookmark bookmark, ArcGIS.Core.Geometry.Envelope envelope)
{
  return QueuedTask.Run(() =>
  {
    //Get the bookmark's definition
    var bookmarkDef = bookmark.GetDefinition();

    //Modify the bookmark's location
    bookmarkDef.Location = envelope;

    //Clear the camera as it is no longer valid.
    bookmarkDef.Camera = null;

    //Set the bookmark definition
    bookmark.SetDefinition(bookmarkDef);
  });
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Bookmark Class
Bookmark Members

Send feedback