Back to Devexpress

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

blazor-devexpress-dot-blazor-dot-richedit-dot-hyperlinks-dot-createasync-x28-system-dot-int32-system-dot-string-system-dot-string-system-dot-string-system-dot-string-system-dot-threading-dot-cancellationtoken-x29.md

latest3.1 KB
Original Source

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

Creates a hyperlink.

Namespace : DevExpress.Blazor.RichEdit

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

NuGet Package : DevExpress.Blazor.RichEdit

Declaration

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

Parameters

NameTypeDescription
positionInt32

The hyperlink start position.

| | text | String |

The hyperlink text.

|

Optional Parameters

NameTypeDefaultDescription
urlStringString.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

TypeDescription
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

Hyperlinks Class

Hyperlinks Members

DevExpress.Blazor.RichEdit Namespace