Description

Gets or sets the text that is displayed in front of the number in a numbered list. If this property is an empty string, no additional text is diplayed in front of the number. This property replaces the CharBeforeNumber property of this class.

Syntax

public string TextBeforeNumber { get; set; }

Public Property TextBeforeNumber As String

Examples

The following example applies TextBeforeNumber while converting three selected paragraphs into a usable numbered list.

textControl.Text = "Research\nDraft\nReview";
textControl.Select(0, textControl.Text.Length);

ListFormat listFormat = new()
{
    Type = ListType.Numbered,
    TextBeforeNumber = "("
};
textControl.Selection.ListFormat = listFormat;

textControl.Text = "Research" & vbCrLf & "Draft" & vbCrLf & "Review"
textControl.Select(0, textControl.Text.Length)

Dim listFormat As New ListFormat() With {
    .Type = ListType.Numbered,
    .TextBeforeNumber = "("
}
textControl.Selection.ListFormat = listFormat

Remarks

The property returns an empty string when the text selection contains multiple paragraphs with mixed settings or when the text selection does not contain a numbered list. The Selection.IsCommonValueSelected method can be used to check for mixed attributes.