Description

Gets or sets the color used to display the text background color at the current input position. If text is selected, the property specifies the background color of the whole selected text.

Syntax

public Color? TextBackColor { get; set; }

Public Property TextBackColor As Color?

Examples

The following XAML example shows how to bind the TextBackColor property to the fill color of a rectangle using the WPF.ColorConverter class.

…
xmlns:tx="clr-namespace:TXTextControl.WPF;assembly=TXTextControl.WPF"
…
<Window.Resources>
    <tx:ColorConverter x:Key="colorConv" />
</Window.Resources>
…
<Rectangle
    Width="20"
    Height="20">
    <Rectangle.Fill>
        <SolidColorBrush
            Color="{Binding
                ElementName=textControl1,
                Path=InputFormat.TextBackColor,
                Converter={StaticResource colorConv}}" />
    </Rectangle.Fill>
</Rectangle>

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

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

inputFormat.TextBackColor = System.Drawing.Color.LightSteelBlue;
if (inputFormat.TextBackColor != null)
{
    Console.WriteLine("Input Format: Text Back Color is available.");
}

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

inputFormat.TextBackColor = System.Drawing.Color.LightSteelBlue
If inputFormat.TextBackColor IsNot Nothing Then
    Console.WriteLine("Input Format: Text Back Color is available.")
End If

Remarks

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