Skip to main content

Hyperlinks.CreateAsync(Int32, Int32, 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(
    int startPosition,
    int length,
    string url = "",
    string bookmarkName = "",
    string tooltip = "",
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name Type Description
startPosition Int32

The hyperlink start position.

length Int32

The hyperlink text length.

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;
            @* ... *@
            await documentAPI.AddTextAsync("From Wikipedia, the free encyclopedia");
            await documentAPI.Hyperlinks.CreateAsync(5, 9, "https://en.wikipedia.org/wiki/Main_Page", "", "");
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}
See Also