TXTextControl.ListFormat Class

An instance of the ListFormat class represents the formatting attributes of a bulleted or numbered list.

Syntax

[C#]
public class ListFormat
[Visual Basic]
Public Class ListFormat

Constructors

Constructor Description
ListFormat Overloaded. Creates a new instance of the ListFormat class.

Properties

Property Description
BulletCharacter Gets or sets the symbol character for a bulleted list.
BulletSize Gets or sets the size of the symbol character for a bulleted list.
CharAfterNumber Obsolete. Gets or sets a character that is displayed behind the number in a numbered list.
CharBeforeNumber Obsolete. Gets or sets a character that is displayed in front of the number in a numbered list.
FirstNumber Gets or sets the starting number for a numbered list.
FontName Gets or sets the font used for the bullet character.
FormatCharacter Gets or sets the formatting character for a bulleted or numbered list.
HangingIndent Gets or sets the hanging indent of a numbered list.
LeftIndent Gets or sets the left indent for a numbered list.
Level Gets or sets the level for a bulleted or numbered list.
NumberFormat Gets or sets the number format for a numbered list.
RestartNumbering Gets or sets a value determining whether a new numbered list begins.
TextAfterNumber Gets or sets the text that is displayed behind the number in a numbered list.
TextBeforeNumber Gets or sets the text that is displayed in front of the number in a numbered list.
Type Gets or sets the type of the list, bulleted, numbered or none.

Enumerations

Enumeration Description
Attribute Determines a certain list format attribute.

Fields

Field Description
MaxLevel Represents the maximum of levels for bulleted and numbered lists.
MaxText Represents the maximum number of charcters for the additinal text in front and behind the number of a numbered list.

Example

The following example shows how to create a new ListFormat and how to apply it at the current input position.

[C#]
TXTextControl.ListFormat lf = new TXTextControl.ListFormat();
lf.Type = TXTextControl.ListType.Numbered;
lf.FirstNumber = 5;

textControl1.Selection.ListFormat = lf;
[Visual Basic]
Dim lf As TXTextControl.ListFormat = New TXTextControl.ListFormat()
lf.Type = TXTextControl.ListType.Numbered
lf.FirstNumber = 5

TextControl1.Selection.ListFormat = lf

See Also