Class ListFormat

Represents the ListFormat class.

Inheritance

System.Object

BaseNode

ListFormat

Namespace: Syncfusion.Windows.Controls.RichTextBoxAdv

Assembly: Syncfusion.SfRichTextBoxAdv.WPF.dll

Syntax

public sealed class ListFormat : BaseNode

Examples

The following code example demonstrates how to define the list format.

<!-- Defines the list format. --> 
<RichTextBoxAdv:ParagraphFormat>
    <RichTextBoxAdv:ParagraphFormat.ListFormat>
        <RichTextBoxAdv:ListFormat ListId="3" ListLevelNumber="0"/>
    </RichTextBoxAdv:ParagraphFormat.ListFormat>
</RichTextBoxAdv:ParagraphFormat>

// Defines the list format.
ParagraphFormat paragraphFormat = new ParagraphFormat();
ListFormat listFormat = new ListFormat();
listFormat.ListId = 3;
listFormat.ListLevelNumber = 0;
paragraphFormat.ListFormat = listFormat;

' Defines the list format.
Dim paragraphFormat As New ParagraphFormat()
Dim listFormat As New ListFormat()
listFormat.ListId = 3
listFormat.ListLevelNumber = 0
paragraphFormat.ListFormat = listFormat

Constructors

ListFormat()

Initializes a new instance of the ListFormat class.

Declaration

public ListFormat()

ListFormat(ParagraphFormat)

Initializes a new instance of the ListFormat class for the specified ParagraphFormat.

Declaration

public ListFormat(ParagraphFormat paragraphFormat)

Parameters

Type	Name	Description
ParagraphFormat	paragraphFormat	The ParagraphFormat associated with the ListFormat.

Fields

ListIdProperty

Identifies the ListId dependency property.

Declaration

public static readonly DependencyProperty ListIdProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the ListId dependency property.

ListLevelNumberProperty

Identifies the ListLevelNumber dependency property.

Declaration

public static readonly DependencyProperty ListLevelNumberProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the ListLevelNumber dependency property.

ListProperty

Identifies the List dependency property.

Declaration

public static readonly DependencyProperty ListProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for the List dependency property.

Properties

List

Gets or sets the ListAdv.

Declaration

public ListAdv List { get; set; }

Property Value

Type	Description
ListAdv	The instance of the ListAdv.

ListId

Gets or sets the identifier of the ListAdv.

Declaration

public int ListId { get; set; }

Property Value

Type	Description
System.Int32	The Id that uniquely identifies the associated ListAdv in the DocumentAdv.

ListLevel

Gets the ListLevelAdv of the ListAdv.

Declaration

public ListLevelAdv ListLevel { get; }

Property Value

Type	Description
ListLevelAdv	Returns null if the ListAdv is not defined. Otherwise returns the ListLevelAdv at the defined level number in the associated ListAdv.

ListLevelNumber

Gets or sets the level number of the ListAdv.

Declaration

public int ListLevelNumber { get; set; }

Property Value

Type	Description
System.Int32	The level number of the ListAdv.

Methods

Dispose()

Releases all resources used by the ListFormat instance.

Declaration

public void Dispose()