TextBlock.LineHeight Property

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the height of each line of content.

Namespace: System.Windows.Controls
Assembly: PresentationFramework (in PresentationFramework.dll)

Syntax

C++

[<TypeConverterAttribute(typeof(LengthConverter))>]
member LineHeight : float with get, set

Property Value

Type: System.Double

The height of line, in device independent pixels, in the range of 0.0034 to 160000. A value of Double.NaN (equivalent to an attribute value of "Auto") indicates that the line height is determined automatically from the current font characteristics. The default is Double.NaN.

Exceptions

Exception	Condition
ArgumentException	LineHeight is set to a non-positive value.

Remarks

Changing this value does not change the height of the associated text; rather, it changes the height of the line that contains the text. To change the size of the text, use the FontSize property.

In addition to this property, the layout of lines in a TextBlock is affected by its LineStackingStrategy property.

This dependency property also has an attached property usage. In XAML, the usage is <object TextBlock.LineHeight="value".../>, where object is an object element (typically a flow element) contained within a TextBlock, and value is a string as explained in XAML Values. In code, the attached property usage is supported by GetLineHeight and SetLineHeight. The attached property usage is not common.

XAML Attribute Usage

<object LineHeight="double"/>
- or -
<object LineHeight="qualifiedDouble"/>
- or -
<object LineHeight="Auto"/>

XAML Values

double

Double

String representation of a Double value equal to or greater than 0.0034 and equal to or less then 160000. An unqualified value is measured in device independent pixels. Strings need not explicitly include decimal points.

qualifiedDouble

A double value as described above, (excepting Auto) followed by one of the following unit specifiers: px, in, cm, pt.

px (default) is device-independent units (1/96th inch per unit)

in is inches; 1in==96px

cm is centimeters; 1cm==(96/2.54) px

pt is points; 1pt==(96/72) px

Auto

Causes the line height to be determined automatically from the current font characteristics. Equivalent to a property value of Double.NaN.

Dependency Property Information

Identifier field	LineHeightProperty
Metadata properties set to true	AffectsMeasure, AffectsRender, Inherits

Examples

The following example shows how to set the LineHeight attribute of a TextBlock element.

XAML

<TextBlock 
  Name="textBlock"

  Background="AntiqueWhite" 
  Foreground="Navy" 

  FontFamily="Century Gothic"
  FontSize="12"
  FontStretch="UltraExpanded"
  FontStyle="Italic"
  FontWeight="UltraBold"

  LineHeight="Auto"
  Padding="5,10,5,10"
  TextAlignment="Center"
  TextWrapping="Wrap"

  Typography.NumeralStyle="OldStyle"
  Typography.SlashedZero="True"
>
  <Run Background="LightGreen">Text run 1.</Run>
  <LineBreak/><Run Background="LightBlue">Text run 2.</Run>
  <LineBreak/><Run Background="LightYellow">Text run 3.</Run>
</TextBlock>

The following example shows how to set the LineHeight property programmatically.

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0