Back to Devexpress

IdxRichEditBookmarkCollection.CreateBookmark(IdxRichEditDocumentPosition,Integer,string) Method

vcl-dxrichedit-dot-nativeapi-dot-idxricheditbookmarkcollection-dot-createbookmark-x28-dxrichedit-dot-nativeapi-dot-idxricheditdocumentposition-system-dot-integer-system-dot-string-x29.md

latest2.2 KB
Original Source

IdxRichEditBookmarkCollection.CreateBookmark(IdxRichEditDocumentPosition,Integer,string) Method

Creates a bookmark for the specified document range.

Declaration

delphi
function CreateBookmark(const AStart: IdxRichEditDocumentPosition; ALength: Integer; const AName: string): IdxRichEditBookmark; overload;

Parameters

NameType
AStartIdxRichEditDocumentPosition
ALengthInteger
ANamestring

Returns

Type
IdxRichEditBookmark

Remarks

Call this function to add a new bookmark to the collection. Pass the document range you need to mark and the bookmark name as the ARange and AName parameters, respectively.

The overloaded variant allows you to specify the bookmarked range by its starting position (the AStart parameter) and length in characters (the ALength parameter).

Note

Alternatively, you can invoke the CreateBookmark function exposed by the IdxRichEditSubDocument interface and its descendants to achieve the same end.

See Also

IdxRichEditBookmarkCollection.GetItem

IdxRichEditBookmarkCollection.Items

IdxRichEditBookmarkCollection.RemoveBookmark

IdxRichEditBookmarkCollection Interface

IdxRichEditBookmarkCollection Members

dxRichEdit.NativeApi Unit