TextDecoration Class
Represents a text decoration, which a visual ornamentation that is added to text (such as an underline).
Assembly: PresentationCore (in PresentationCore.dll)
| Name | Description | |
|---|---|---|
![]() | TextDecoration() | Initializes a new instance of the TextDecoration class. |
![]() | TextDecoration(TextDecorationLocation, Pen^, Double, TextDecorationUnit, TextDecorationUnit) | Initializes a new instance of the TextDecoration class with the specified Location, Pen, PenOffset, PenOffsetUnit, and PenThicknessUnit values. |
| Name | Description | |
|---|---|---|
![]() | CanFreeze | Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.) |
![]() | DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) |
![]() | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
![]() | HasAnimatedProperties | Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.) |
![]() | IsFrozen | Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.) |
![]() | IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.) |
![]() | Location | Gets or sets the vertical location at which the text decoration is drawn. |
![]() | Pen | Gets or sets the Pen used to draw the text decoration. |
![]() | PenOffset | Gets or sets the text decoration's offset from its Location. |
![]() | PenOffsetUnit | Gets the units in which the PenOffset value is expressed. |
![]() | PenThicknessUnit |
| Name | Description | |
|---|---|---|
![]() | ApplyAnimationClock(DependencyProperty^, AnimationClock^) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.) |
![]() | ApplyAnimationClock(DependencyProperty^, AnimationClock^, HandoffBehavior) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty^, AnimationTimeline^) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty^, AnimationTimeline^, HandoffBehavior) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.) |
![]() | CheckAccess() | Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.) |
![]() | ClearValue(DependencyProperty^) | Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.) |
![]() | ClearValue(DependencyPropertyKey^) | Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.) |
![]() | Clone() | Creates a modifiable clone of this TextDecoration, making deep copies of this object's values. |
![]() | CloneCurrentValue() | Creates a modifiable clone of this TextDecoration object, making deep copies of this object's current values. |
![]() | CoerceValue(DependencyProperty^) | Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.) |
![]() | Equals(Object^) | Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.) |
![]() | Freeze() | |
![]() | GetAnimationBaseValue(DependencyProperty^) | Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.) |
![]() | GetAsFrozen() | |
![]() | GetCurrentValueAsFrozen() | |
![]() | GetHashCode() | Gets a hash code for this DependencyObject.(Inherited from DependencyObject.) |
![]() | GetLocalValueEnumerator() | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetType() | |
![]() | GetValue(DependencyProperty^) | Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.) |
![]() | InvalidateProperty(DependencyProperty^) | Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.) |
![]() | ReadLocalValue(DependencyProperty^) | Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.) |
![]() | SetCurrentValue(DependencyProperty^, Object^) | Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyProperty^, Object^) | Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyPropertyKey^, Object^) | Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.) |
![]() | ShouldSerializeProperty(DependencyProperty^) | Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.) |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
![]() | VerifyAccess() | Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.) |
| Name | Description | |
|---|---|---|
![]() ![]() | LocationProperty | Identifies the Location dependency property. |
![]() ![]() | PenOffsetProperty | Identifies the PenOffset dependency property. |
![]() ![]() | PenOffsetUnitProperty | Identifies the PenOffsetUnit dependency property. |
![]() ![]() | PenProperty | Identifies the Pen dependency property. |
![]() ![]() | PenThicknessUnitProperty | Identifies the PenThicknessUnit dependency property. |
There are four types of text decorations: underline, baseline, strikethrough, and overline. The following example shows the locations of the text decorations relative to the text.

Example of text decoration types
The following example shows a text decoration that has been styled with a linear gradient brush and a dashed pen.

Example of an underline styled with a linear gradient brush and dashed pen
Notice that TextDecoration is derived from Animatable. This makes it possible to apply animated effects to the decoration elements, using a DoubleAnimation for the PenOffset and a ThicknessAnimation for the Pen.
Available since 3.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.





