Back to Devexpress

CharacterProperties.Script Property

blazor-devexpress-dot-blazor-dot-richedit-dot-characterproperties.md

latest3.2 KB
Original Source

CharacterProperties.Script Property

Specifies the script format of characters.

Namespace : DevExpress.Blazor.RichEdit

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

NuGet Package : DevExpress.Blazor.RichEdit

Declaration

csharp
public CharacterFormattingScript? Script { get; set; }

Property Value

TypeDescription
Nullable<CharacterFormattingScript>

The script format or null if at least two different characters have different script formats.

|

Available values:

NameDescription
Normal

Specifies that the text is not formatted as subscript or superscript.

| | Subscript |

Formats text as subscript.

| | Superscript |

Formats text as superscript.

|

Remarks

Use a text span’s Script or a table cell’s CharacterProperties.Script property to obtain the script format of characters in the span or cell. Call the TextSpan.ChangePropertiesAsync or TableCell.ChangePropertiesAsync method to apply a script format to characters.

The following example removes subscript and superscript font attributes from all characters in a text span:

razor
<DxRichEdit @ref="richEdit" />

@code {
    DxRichEdit richEdit;
    Document documentAPI;

    protected override async Task OnAfterRenderAsync(bool firstRender) {
        if (firstRender)
            try {
                await InitializeDocument();
            }
            catch (TaskCanceledException) { }
        await base.OnAfterRenderAsync(firstRender);
    }

    async Task InitializeDocument() {
    /* 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;
            TextSpan characters = await documentAPI.AddTextAsync("New Text");
            await characters.ChangePropertiesAsync(properties => {
                properties.Script = CharacterFormattingScript.Normal;
            });
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
    }
}

Implements

Script

See Also

CharacterProperties Class

CharacterProperties Members

DevExpress.Blazor.RichEdit Namespace