TX Text Control .NET Server

StructuredListFormat Property

Property|Introduced in 16.0

Namespace: TXTextControl

Package: TXTextControl.TextControl.Core.SDK as TXTextControl.Core.dll from the private NuGet feed or Text Control Offline Packages

Also in: TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Gets or sets the number format for a structured list at the current input position. If text is selected, the property specifies this attribute for the whole selected text. This property determines the number format for the StructuredList property. The property's value is a member of the NumberFormat enumeration.

Syntax

public NumberFormat StructuredListFormat { get; set; }

Public Property StructuredListFormat As NumberFormat

Members

Value	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 XAML example shows how to bind radio buttons to the StructuredListFormat property using the WPF.BooleanConverter class and the NumberFormats property.

…
xmlns:tx="clr-namespace:TXTextControl.WPF;assembly=TXTextControl.WPF"
…
<Window.Resources>
    <tx:BooleanConverter x:Key="boolConv" />
</Window.Resources>
…
<RadioButton
    Content="{Binding ElementName=textControl1, Path=InputFormat.NumberFormats[0], Mode=OneTime}"
    GroupName="structuredListFormat"
    IsChecked="{Binding
        ElementName=textControl1,
        Path=InputFormat.StructuredListFormat,
        Converter={StaticResource boolConv},
        ConverterParameter=ArabicNumbers}" />
<RadioButton
    Content="{Binding ElementName=textControl1, Path=InputFormat.NumberFormats[1], Mode=OneTime}"
    GroupName="structuredListFormat"
    IsChecked="{Binding
        ElementName=textControl1,
        Path=InputFormat.StructuredListFormat,
        Converter={StaticResource boolConv},
        ConverterParameter=Letters}" />
…

The following example changes the formatting applied to text entered at the end of a document by using InputFormat.StructuredListFormat.

textControl.Text = "Project summary";
textControl.InputPosition = new InputPosition(textControl.Text.Length);
InputFormat inputFormat = textControl.InputFormat;

inputFormat.StructuredListFormat = NumberFormat.ArabicNumbers;
Console.WriteLine($"Structured List Format used by Input Format: {inputFormat.StructuredListFormat}");

textControl.Text = "Project summary"
textControl.InputPosition = New InputPosition(textControl.Text.Length)
Dim inputFormat As InputFormat = textControl.InputFormat

inputFormat.StructuredListFormat = NumberFormat.ArabicNumbers
Console.WriteLine($"Structured List Format used by Input Format: {inputFormat.StructuredListFormat}")

Remarks

The property's default value is NumberFormat.ArabicNumbers.

The property returns NumberFormat.None, if the text selection has no common number format.