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

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

Gets or sets the formatting character for a bulleted or numbered list.

Syntax

C#
VB.NET

public ListFormatCharacter FormatCharacter { get; set; }

Public Property FormatCharacter() As ListFormatCharacter

Members

Member	Description
Tab	The text of the list follows the bullet or number character at the next tab position.
Space	The text of the list follows the bullet or number character separated through a space character.
None	The text of the list immediately follows the bullet or number character.

Examples

The following example uses the FormatCharacter property and sets its value to 'ListFormatCharacter.Tab'.

C#
VB.NET

TXTextControl.ListFormat lf = new TXTextControl.ListFormat();
lf.Type = TXTextControl.ListType.Numbered
lf.FirstNumber = 5;
lf.FontName = "Calibri";
lf.BulletCharacter = '>';
lf.BulletSize = 12;
lf.FormatCharacter = TXTextControl.ListFormatCharacter.Tab;

textControl1.Selection.ListFormat = lf;

Dim lf As TXTextControl.ListFormat = New TXTextControl.ListFormat()
lf.Type = TXTextControl.ListType.Numbered
lf.FirstNumber = 5
lf.FontName = "Calibri"
lf.BulletCharacter = ">"c
lf.BulletSize = 12
lf.FormatCharacter = TXTextControl.ListFormatCharacter.Tab

textControl1.Selection.ListFormat = lf

Remarks

The property's default value is ListFormatCharacter.Tab.

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