DxRichEdit.DocumentAPI Property

Provides access to the document’s common and the main sub-document‘s functionalities.

Namespace: DevExpress.Blazor.RichEdit

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

Declaration

public Document DocumentAPI { get; }

Property Value

Type Description
Document

An object that lists document structural elements.

Remarks

Use the DocumentAPI property to access the main sub-document‘s structural elements (for instance, section, hyperlinks, tables) and members related to common document functionality.

The code sample below shows how to change properties of every paragraph in the main sub-document. The BeginUpdate(Boolean) and EndUpdate() methods suppress the RichEdit’s visual updates until every paragraph is processed.

<DxRichEdit @ref="richEdit" />
@code {
    DxRichEdit richEdit;
    @* ... *@
    /* 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 cancelled. */
        try {
            richEdit.DocumentAPI.BeginUpdate();
            IReadOnlyList<Paragraph> paragraphs = await richEdit.DocumentAPI.Paragraphs.GetAllAsync();
            foreach (Paragraph p in paragraphs)
                await p.ChangePropertiesAsync(properties => {/*...*/});
            richEdit.DocumentAPI.EndUpdate();
            }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}
See Also