Applies to

TPlusGutter component

Declaration

type

  TpgBookmarkEvent = procedure (Sender: TObject; 

                                BookmarkIndex: TBookmarkRange;

                                Navigator: TPlusNavigator;

                                var Accept: Boolean) of object;

property OnClearBookmark: TpgBookmarkEvent;

property OnSetBookmark: TpgBookmarkEvent;

Description

These events occur whenever a bookmark is about to be added or removed in a TPlusGutter.  An application can use them to be notified about bookmark modifications, or to implement complex rules for accepting or rejecting the modification.

Parameter Sender is the TPlusGutter for which the event is generated.  BookmarkIndex is the bookmark number that is being affected.  Navigator is a reference to an object that can be used to get position information about the place where the bookmark is (in the  case of OnClearBookmark) or where it will be added (for OnSetBookmark).  Parameter Accept is True when entering the event.  Setting it to False before returning will cancel the bookmark addition or removal.