Skip to main content

Hyperlinks.CreateAsync(Interval, String, String, String, CancellationToken) Method

Creates a hyperlink.

Namespace: DevExpress.Blazor.RichEdit

Assembly: DevExpress.Blazor.RichEdit.v24.1.dll

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask<Hyperlink> CreateAsync(
    Interval interval,
    string url = "",
    string bookmarkName = "",
    string tooltip = "",
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name Type Description
interval Interval

The sub-document’s text span interval in which to create the hyperlink.

Optional Parameters

Name Type Default Description
url String String.Empty

The hyperlink URL.

bookmarkName String String.Empty

The bookmark name.

tooltip String String.Empty

The tooltip text.

cancellationToken CancellationToken null

An object that propagates a cancellation notification.

Returns

Type Description
ValueTask<Hyperlink>

A structure that stores an awaitable result of an asynchronous operation. The awaitable result is the hyperlink object.

Remarks

<DxRichEdit @ref="richEdit" />
@code {
    DxRichEdit richEdit;
    Document documentAPI;
    @* ... *@
    /* Surround the code that contains an asynchronous operation with a try-catch block to handle
    the OperationCanceledException. This exception is thrown when an asynchronous operation is canceled. */
        try {
            documentAPI = richEdit.DocumentAPI;
            @* ... *@
            // Make every 'DevExpress' text link
            var DX_Intervals = await documentAPI.FindAllAsync("DevExpress", true);
            for (int i = 0; i < DX_Intervals.Count; i++) {
                await documentAPI.Hyperlinks.CreateAsync(DX_Intervals[i], "https://www.devexpress.com/", "", "Go to DevExpress");
                DX_Intervals = await documentAPI.FindAllAsync("DevExpress", true);
            }
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}
See Also