TX Text Control .NET Server

TopDistance 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 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; }

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.");
}

Remarks

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.