TextDecoration.PenOffset Property

Reference

Definition

Namespace:: System.Windows

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the text decoration's offset from its Location.

public:
 property double PenOffset { double get(); void set(double value); };

public double PenOffset { get; set; }

member this.PenOffset : double with get, set

Public Property PenOffset As Double

Property Value

Double

The text decoration's offset from its Location. The default is 0.

Examples

The following code example shows how to set the PenOffset property.

// Move the text decoration lower using pixel value units.
myUnderline.PenOffset = 2;
myUnderline.PenOffsetUnit = TextDecorationUnit.Pixel;
myUnderline.PenThicknessUnit = TextDecorationUnit.Pixel;

' Move the text decoration lower using pixel value units.
myUnderline.PenOffset = 2
myUnderline.PenOffsetUnit = TextDecorationUnit.Pixel
myUnderline.PenThicknessUnit = TextDecorationUnit.Pixel

<!-- Move the text decoration lower using pixel value units. -->
<TextDecoration PenOffset="2" PenOffsetUnit="Pixel" PenThicknessUnit="Pixel" />

Remarks

A negative value moves the text decoration higher, while a positive value moves the text decoration lower. Use the PenOffsetUnit property to specify how the units of this value are interpreted.

Dependency Property Information

Item	Value
Identifier field	PenOffsetProperty
Metadata properties set to `true`	None

Applies to

Jaa