ElementCollection<TElement>.GetAsync(Int32, CancellationToken) Method

Returns an element with the specified index.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask<TElement> GetAsync(
    int index,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name	Type	Description
index	Int32	The element index in the collection.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	An object that propagates a cancellation notification.

Returns

Type	Description
ValueTask<TElement>	A structure that stores an awaitable result of an asynchronous operation. The awaitable result is an element with the specified index.

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;
            @* ... *@
            // Gets URLs of all hyperlinks in the document
            List<string> hyperlinkUrls = new List<string>();
            var hyperlinks = await documentAPI.Hyperlinks.GetAllAsync();
            for (int i = 0; i < hyperlinks.Count; i++) {
                var hLink = await documentAPI.Hyperlinks.GetAsync(i);
                if (hLink.Url != "")
                    hyperlinkUrls.Add(hLink.Url);
            }
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}