TXTextControl.ListFormat.NumberFormat Property - TX Text Control .NET for Windows Forms

TX Text Control .NET for Windows FormsReference GuideTXTextControl NamespaceListFormat ClassNumberFormat Property

Gets or sets the number format for a numbered list. The property's value is a member of the NumberFormat enumeration.

Syntax

C#
VB.NET

public NumberFormat NumberFormat { get; set; }

Public Property NumberFormat() As NumberFormat

Members

Member	Description
ArabicNumbers	The list is numbered with Arabic numbers (1, 2, 3...).
Letters	The list is numbered with letters (a, b, c...).
CapitalLetters	The list is numbered with capital letters (A, B, C...).
RomanNumbers	The list is numbered with Roman numbers (I, II, III...).
SmallRomanNumbers	The list is numbered with small Roman numbers (i, ii, iii...).

Examples

The following example uses NumberFormat property and sets its value as Letters.

C#
VB.NET

TXTextControl.ListFormat lf = new TXTextControl.ListFormat();

lf.Type         = TXTextControl.ListType.Numbered;
lf.NumberFormat = TXTextControl.NumberFormat.Letters;

textControl1.Selection.ListFormat = lf;

Dim lf As TXTextControl.ListFormat = New TXTextControl.ListFormat()

lf.Type         = TXTextControl.ListType.Numbered
lf.NumberFormat = TXTextControl.NumberFormat.Letters;

TextControl1.Selection.ListFormat = lf

Remarks

The property's default value is NumberFormat.ArabicNumbers.

The property returns its default value when the text selection contains multiple paragraphs with mixed number formats or when the text selection does not contain a numbered list. The Selection.IsCommonValueSelected method can be used to check for mixed attributes.