TopDistance Property
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. WinForms. SDK TXTextControl.from the private NuGet feed or Text Control Offline Packagesdll
Description
Gets or sets a top paragraph distance, in twips, at the current input position. If text is selected, the property specifies the top distance of the whole selected text.
Syntax
public int? TopDistance { get; set; }Public Property TopDistance As Integer?Examples
The following XAML example binds the TopDistance property to a text box using the WPF.MeasureConverter class. The value of the top distance is converted to centimeter.
…
xmlns:tx="clr-namespace:TXTextControl.WPF;assembly=TXTextControl.WPF"
…
<Window.Resources>
<tx:MeasureConverter Unit="Centimeter" x:Key="twipsConv" />
</Window.Resources>
…
<TextBox
Text="{Binding
ElementName=textControl1,
Path=InputFormat.TopDistance,
Converter={StaticResource twipsConv},
Mode=TwoWay}" />The following example changes the formatting applied to text entered at the end of a document by using InputFormat.TopDistance.
textControl.Text = "Project summary";
textControl.InputPosition = new InputPosition(textControl.Text.Length);
InputFormat inputFormat = textControl.InputFormat;
inputFormat.TopDistance = 720;
if (inputFormat.TopDistance != null)
{
Console.WriteLine("Input Format: Top Distance is available.");
}textControl.Text = "Project summary"
textControl.InputPosition = New InputPosition(textControl.Text.Length)
Dim inputFormat As InputFormat = textControl.InputFormat
inputFormat.TopDistance = 720
If inputFormat.TopDistance IsNot Nothing Then
Console.WriteLine("Input Format: Top Distance is available.")
End IfRemarks
The property returns null when the text selection contains multiple paragraphs with different top distances.
The WPF.MeasureConverter can be used to convert the property value to another measuring unit.