BookmarkCollection.Create(DocumentRange, String) Method

Creates a bookmark for the specified range with the specified name and adds it to the collection.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

Bookmark Create(
    DocumentRange range,
    string name
)

VB.NET

Function Create(
    range As DocumentRange,
    name As String
) As Bookmark

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange specifying a portion of a document contained within the bookmark.
name	String	A string specifying the bookmark name.

Returns

Type	Description
Bookmark	A Bookmark object specifying the created bookmark.

Remarks

If the document already contains a bookmark with the specified name, an InvalidOperationException occurs. The BookmarkOptions.AllowNameResolution option is not applicable in this situation.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Create(DocumentRange, String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-insert-text-between-two-bookmarks-e4405/CS/CS/BookmarkInsertLR/Form1.cs#L22

document.InsertText(document.CreatePosition(0), "Bookmark 1Bookmark 2Bookmark 3Bookmark 4");
document.Bookmarks.Create(document.CreateRange(0, 10), "b1");
document.Bookmarks.Create(document.CreateRange(10, 10), "b2");

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/BookmarksAndHyperlinksActions.cs#L19

DocumentPosition pos = document.Range.Start;
document.Bookmarks.Create(document.CreateRange(pos, 0), "Top");
//Insert the hyperlink anchored to the created bookmark:

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/BookmarksAndHyperlinks.cs#L19

 DocumentPosition pos = document.Range.Start;
 document.Bookmarks.Create(document.CreateRange(pos, 0), "Top");
//Insert the hyperlink anchored to the created bookmark:

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/CS/WindowsFormsApplication1/Form1.cs#L64

    DocumentRange protectedParagraph = document.Paragraphs.Get(protectedRanges[i].Start).Range;
    document.Bookmarks.Create(protectedParagraph, "protectedRange" + (i + 1).ToString());
}

bookmarks-and-hyperlinks-simple-example-t548777/CS/BookmarksAndHyperlinksSimpleExample/Form1.cs#L54

//Create a bookmark to a given position
document.Bookmarks.Create(document.CreateRange(pos, 1), "Top");

VB.NET

how-to-insert-text-between-two-bookmarks-e4405/VB/CS/BookmarkInsertLR/Form1.vb#L24

document.InsertText(document.CreatePosition(0), "Bookmark 1Bookmark 2Bookmark 3Bookmark 4")
document.Bookmarks.Create(document.CreateRange(0, 10), "b1")
document.Bookmarks.Create(document.CreateRange(10, 10), "b2")

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/BookmarksAndHyperlinksActions.vb#L16

Dim pos As DocumentPosition = document.Range.Start
document.Bookmarks.Create(document.CreateRange(pos, 0), "Top")
'Insert the hyperlink anchored to the created bookmark:

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/BookmarksAndHyperlinks.vb#L16

 Dim pos As DocumentPosition = document.Range.Start
 document.Bookmarks.Create(document.CreateRange(pos, 0), "Top")
'Insert the hyperlink anchored to the created bookmark:

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/VB/WindowsFormsApplication1/Form1.vb#L66

    Dim protectedParagraph As DocumentRange = document.Paragraphs.Get(protectedRanges(i).Start).Range
    document.Bookmarks.Create(protectedParagraph, "protectedRange" & (i + 1).ToString())
Next i

bookmarks-and-hyperlinks-simple-example-t548777/VB/BookmarksAndHyperlinksSimpleExample/Form1.vb#L51

'Create a bookmark to a given position
document.Bookmarks.Create(document.CreateRange(pos, 1), "Top")