Back to Devexpress

ListType Enum

blazor-devexpress-dot-blazor-dot-richedit-774a4020.md

latest2.7 KB
Original Source

ListType Enum

Lists values that specify the list type.

Namespace : DevExpress.Blazor.RichEdit

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

NuGet Package : DevExpress.Blazor.RichEdit

Declaration

csharp
public enum ListType

Members

NameDescription
MultiLevel

The multilevel list.

| | Number |

The numbered list.

| | Bullet |

The bulleted list.

|

The following properties accept/return ListType values:

Remarks

Pass a ListType enumeration’s value to the CreateAsync(ListType, CancellationToken) method to create a list of the specified type. Use a list’s Type property value to get the type of the list.

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;
            List multiLevelList = await documentAPI.Lists.CreateAsync(ListType.MultiLevel);
            IReadOnlyList<ListLevel> listLevels = multiLevelList.ListLevels;
            ListLevel firstLevel = listLevels[0];
            for (int i = 1; i < 9; i++)
                await multiLevelList.ChangeLevelPropertiesAsync(i, properties => {
                    properties.CopyFrom(firstLevel);
                    properties.LeftIndent = firstLevel.LeftIndent + 300 * i;
                    if (multiLevelList.Type == ListType.Number)
                        properties.DisplayFormatString = "{" + i.ToString() + "}";
                });
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

The type of a list defines the default property values for all list levels. Call the ChangeLevelPropertiesAsync(Int32, Action<ListLevelProperties>, CancellationToken) method to change a list level’s properties.

See Also

DevExpress.Blazor.RichEdit Namespace