Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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

Creates a hyperlink.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

#Declaration

C#
public ValueTask<Hyperlink> CreateAsync(
    int position,
    string text,
    string url = "",
    string bookmarkName = "",
    string tooltip = "",
    CancellationToken cancellationToken = default(CancellationToken)
)

#Parameters

Name Type Description
position Int32

The hyperlink start position.

text String

The hyperlink text.

#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

Razor
<DxRichEdit @bind-Selection="@selection" @ref="@richEdit" />

@code {
    DxRichEdit richEdit;
    Selection selection;
    @* ... *@
    /* 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 {
        @* ... *@
            // Insert a hyperlink to a URL
            var position = richEdit.Selection.CaretPosition;
            await documentAPI.Hyperlinks.CreateAsync(position, "Go to Google", "https://www.google.com/");
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}
See Also