Hyperlinks and Bookmarks

  • 5 minutes to read

This topic consists of the following sections:

The following members allow you to create a Hyperlink in code:

Member Description
SubDocument.FindAll Searches for every range that contains the given text string.
HyperlinkCollection.Create Creates a new item in the HyperlinkCollection.
Hyperlink.NavigateUri Specifies the URI for the hyperlink to navigate to.
DocumentHyperlink.ToolTip Specifies a tooltip - a text displayed when the mouse hovers over a hyperlink.

The code snippet below finds a specific range in the document and converts it to a hyperlink with a given URI and a tooltip:

RichEditControl_Hyperlinks_Result

Document document = richEditControl1.Document;

//Find the specific text string in a document
DocumentRange[] foundRanges = document.FindAll("DevExpress WinForms Rich Text Editor",
SearchOptions.CaseSensitive);
if (foundRanges.Length > 0)
{
    //Create a hyperlink from a found range
    document.Hyperlinks.Create(foundRanges[0]);

    //Set the URI and the tooltip for the created hyperlink
    document.Hyperlinks[0].NavigateUri = "https://www.devexpress.com/Products/NET/Controls/WinForms/Rich_Editor/";
    document.Hyperlinks[0].ToolTip = "WinForms Rich Text Editor";
}

Use the HyperlinkOptions class properties to complete the following tasks:

The code snippet below shows how to specify these properties in code:

hyperlinkOptions = richEditControl1.Options.Hyperlinks;

hyperlinkOptions.EnableUriCorrection = false;
hyperlinkOptions.ModifierKeys = Keys.Shift;
hyperlinkOptions.ShowToolTip = true;

Handle the RichEditControl.HyperlinkClick event to perform custom actions when a hyperlink is activated. Refer to the How to: Handle the HyperlinkClick Event to Invoke the Custom Form topic for more details.

NOTE

The hyperlink is a specific kind of a document field, therefore the DocumentCapabilitiesOptions.Fields property affects the hyperlink loading process when importing the document. Set the RichEditControlCompatibility.LoadHyperlinkAsField property to false before calling the InitializeComponent method to correct this behavior and allow loading hyperlinks when loading fields is disabled.

Bookmarks

Create a Bookmark

The following code snippet creates a Bookmark and a hyperlink which navigates to the created bookmark using API from the table below:

Member Description
SubDocument.BeginUpdate Enables document modification.
BookmarkCollection.Create Creates a bookmark at the given document position.
DocumentHyperlink.Anchor Connects a bookmark with a specific hyperlink.
SubDocument.EndUpdate Finalizes the document update.
Document document = richEditControl1.Document;
document.BeginUpdate();
DocumentPosition pos = document.Range.Start;

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

//Insert the hyperlink anchored to the created bookmark:
DocumentRange[] foundRanges = document.FindAll("To the Top", SearchOptions.CaseSensitive);
if (foundRanges.Length > 0)
{
    document.Hyperlinks.Create(foundRanges[0]);
    document.Hyperlinks[1].Anchor = "Top";
}
document.EndUpdate();

The animation below shows the result:

RichEditControl_Bookmarks_Gif

NOTE

If a new bookmark name duplicates the existing one, an InvalidOperationException exception is thrown with the message obtained from the XtraRichEditStringId.Msg_DuplicateBookmark resource string that reads "Bookmark with that name already exists in the document". Use the BookmarkOptions.ConflictNameResolution property to programmatically process bookmarks with duplicate names which may appear in your document.

Visualize the Bookmark

Use the following properties to highlight bookmarks within the document:

BookmarkOptions bookmarkOptions;

bookmarkOptions = richEditControl1.Options.Bookmarks;
bookmarkOptions.Visibility = RichEditBookmarkVisibility.Visible;
bookmarkOptions.Color = Color.Sienna;

With these properties specified, the bookmarks are displayed the following way:

XtraRichEdit_Bookmarks

Export Bookmarks to the PDF format

You can specify what bookmarks can be displayed in the Bookmarks panel when you export the document to PDF format. Set the BookmarkOptions.DisplayBookmarksInPdfNavigationPane property to one of the DevExpress.XtraRichEdit.PdfBookmarkDisplayMode enumeration values, as shown below:

richEditControl.Options.Bookmarks.DisplayBookmarksInPdfNavigationPane = PdfBookmarkDisplayMode.TocBookmarks;

Use the BookmarkOptions.DisplayUnreferencedPdfBookmarks property to determine whether to show bookmarks without references (i.e., without hyperlinks anchored to these bookmarks) in the Bookmarks navigation pane. The DisplayBookmarksInPdfNavigationPane property set PdfBookmarkDisplayMode.None controls the unreferenced bookmarks when the DisplayUnreferencedPdfBookmarks property is set to true.

End-users can insert a bookmark or hyperlink in the document using the Links group of the Insert ribbon tab. Refer to the How to: Create the RichEditControl with a Ribbon UI topic for details on how to provide the application with the Ribbon Command UI.

XtraRichEdit_BookmarksAndHyperlinks_LinksRibbonGroup

Additionally, RichEditControl provides the following dialogs which allow end-users to manage hyperlinks or bookmarks:

TIP

Set the DocumentCapabilitiesOptions.Hyperlinks or DocumentCapabilitiesOptions.Bookmarks property to DocumentCapability.Disabled to restrict end-users' use of hyperlinks or bookmarks.

See Also