Document.ChangeDefaultCharacterPropertiesAsync(Action<CharacterProperties>, CancellationToken) Method

Sets the default character formatting in the document.

Namespace : DevExpress.Blazor.RichEdit

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

NuGet Package : DevExpress.Blazor.RichEdit

Declaration

public ValueTask ChangeDefaultCharacterPropertiesAsync(
    Action<CharacterProperties> modifier,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

A delegate method that configures default values of the character properties.

|

Optional Parameters

An object that propagates a cancellation notification.

|

Returns

A structure that stores an awaitable result of an asynchronous operation.

|

Remarks

Call the ChangeDefaultCharacterPropertiesAsync method to change an open document’s default character formatting. Refer to the following link for a list of all available format settings: CharacterProperties.

The following code snippet changes default font name and size of a document’s text once the document is loaded in the Rich Text Editor:

<DxRichEdit DocumentLoaded=OnDocumentLoaded/>

@code {
    async Task OnDocumentLoaded(Document document) {
        await document.ChangeDefaultCharacterPropertiesAsync(properties => {
            properties.FontName = "Times New Roman";
            properties.FontSize = 12;
        });
    }
}

The Rich Text Editor applies the default character formatting to a text interval in the following cases:

• You call a ClearFormattingAsync method overload:

• A user selects the Clear Formatting ribbon command.

• A user presses Ctrl + Space Bar.

To customize character properties of a text span, call its ChangePropertiesAsync method.

See Also

Document Class

Document Members

DevExpress.Blazor.RichEdit Namespace