ListLevelProperties.DisplayFormatString Property

Specifies the pattern used to format the list level’s number or bullet.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public string DisplayFormatString { get; set; }

Property Value

Type	Description
String	The format pattern.

Remarks

The format pattern can include fixed literals and indexed placeholders.

An indexed placeholder is an integer from 0 to 8 enclosed in curly brackets (for instance, “{0}”). A placeholder index corresponds to the list level’s number or bullet depending on the ListLevelFormat property value.

The following example shows how you can use the DisplayFormatString property to set the ◆ bullet for the 0 list level.

<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;
            List multiLevelList = await documentAPI.Lists.CreateAsync(ListType.MultiLevel);
            IReadOnlyList<ListLevel> listLevels = multiLevelList.ListLevels;
            ListLevel firstLevel = listLevels[0];
            await multiLevelList.ChangeLevelPropertiesAsync(0, properties => {
                if (firstLevel.DisplayFormatString != "\u25C6")
                    properties.DisplayFormatString = "\u25C6";
            });
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}