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

Fields.CreateAsync(Interval, CancellationToken) Method

Creates a field in the specified interval.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

#Declaration

C#
public ValueTask<Field> CreateAsync(
    Interval interval,
    CancellationToken cancellationToken = default(CancellationToken)
)

#Parameters

Name Type Description
interval Interval

The interval where to create the field.

#Optional Parameters

Name Type Default Description
cancellationToken CancellationToken null

An object that propagates a cancellation notification.

#Returns

Type Description
ValueTask<Field>

A structure that stores an awaitable result of an asynchronous operation. The awaitable result is a field object.

#Remarks

Call the CreateAsync(Interval) method to wrap the specified interval in a new field.

The following example creates a PAGE field in a header:

Razor
<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;
            @* ... *@
            // Accesses a header
            Section section = await documentAPI.Sections.GetAsync(0);
            SubDocument header = await section.GetHeaderAsync(HeaderFooterType.Primary, true);
            // Inserts the "PAGE" text in the header
            TextSpan pageNumber = await header.AddTextAsync("PAGE");
            // Creates a PAGE field
            Field pageField = await header.Fields.CreateAsync(pageNumber.Interval);
            // Updates the field
            await header.Fields.UpdateAsync(pageField);
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

Update a field to calculate and display the field result. The UpdateAsync(Field, CancellationToken) method allows you to update a field. Call the UpdateAllAsync(Boolean, CancellationToken) method to update every field in a sub-document or in all sub-documents.

See Also