TX Text Control .NET for Windows Forms

AutoBaseline Property

Property|Introduced in 30.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.WinForms.SDK as TXTextControl.dll from the private NuGet feed or Text Control Offline Packages

Description

Gets or sets values specifying wheather the selected text is automatically sub- or superscripted. When using automatic sub- and superscript the font is scaled and moved above or below the baseline with values defined through the font itself. Automatic sub- and superscript can be combined with a user-defined baseline which can be set with the Baseline property.

Syntax

public AutoBaseline AutoBaseline { get; set; }

Members

ValueDescription
NoneText is not sub- or superscripted.
SuperscriptText is moved above the baseline.
SubscriptText is moved below the baseline.
SuperscriptUpperEdgeText is scaled und moved above the baseline. The moved text does not extend above the upper edge of capital letters. This can be used for nominators of diagonal fractions.
SubscriptBaselineText is scaled, but is not moved below the baseline. This can be used for denominators of diagonal fractions.

Examples

The following example formats the heading of a short document by using Selection.AutoBaseline.

textControl.Text = "Quarterly results\nRevenue increased by 12%.";
textControl.Select(0, 17);
Selection selection = textControl.Selection;

selection.AutoBaseline = AutoBaseline.Superscript;
Console.WriteLine($"Auto Baseline used by Selection: {selection.AutoBaseline}");

Remarks

The property's default value is AutoBaseline.None.

The property returns its default value when the text selection contains multiple characters with mixed settings. The Selection.IsCommonValueSelected method can be used to check for mixed attributes.