Description

Gets or sets a value specifying whether text is underlined at the current input position. The underlining style is determined through the UnderlineStyle property. If text is selected, the property specifies this attribute for the whole selected text.

Syntax

public bool? Underline { get; set; }

Public Property Underline As Boolean?

Examples

The following XAML example binds the Underline property to a check box:

<CheckBox
    Height="20"
    Name="checkBoxUnderline"
    IsChecked="{Binding ElementName=textControl1, Path=InputFormat.Underline, Mode=TwoWay}">
    Underline</CheckBox>

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

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

inputFormat.Underline = true;
if (inputFormat.Underline != null)
{
    Console.WriteLine("Input Format: Underline is available.");
}

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

inputFormat.Underline = True
If inputFormat.Underline IsNot Nothing Then
    Console.WriteLine("Input Format: Underline is available.")
End If

Remarks

The property returns null when the text selection contains multiple characters with mixed styles.