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(Int32, String, CancellationToken) Method

Creates a field with the specified code.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

#Declaration

C#
public ValueTask<Field> CreateAsync(
    int position,
    string code,
    CancellationToken cancellationToken = default(CancellationToken)
)

#Parameters

Name Type Description
position Int32

A position where to create a field.

code String

A field code.

#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

A field has the {Code}Result> structure in the text buffer, for instance, {DATE}11/2/2020>. The Code specifies how the Result should be calculated when the field is updated. Call the CreateAsync(Int32, String) method to create a field with the specified code.

The following example shows how you can create a DATE field at the beginning of the main sub-document:

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;
            @* ... *@
            Field dateField = await documentAPI.Fields.CreateAsync(0, "DATE");
            await documentAPI.Fields.UpdateAsync(dateField);
            @* ... *@
        }
        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