TextDecoration Class

 

Represents a text decoration, which a visual ornamentation that is added to text (such as an underline).

Namespace:   System.Windows
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.DependencyObject
      System.Windows.Freezable
        System.Windows.Media.Animation.Animatable
          System.Windows.TextDecoration

[LocalizabilityAttribute(LocalizationCategory.None)]
public sealed class TextDecoration : Animatable

NameDescription
System_CAPS_pubmethodTextDecoration()

Initializes a new instance of the TextDecoration class.

System_CAPS_pubmethodTextDecoration(TextDecorationLocation, Pen, Double, TextDecorationUnit, TextDecorationUnit)

Initializes a new instance of the TextDecoration class with the specified Location, Pen, PenOffset, PenOffsetUnit, and PenThicknessUnit values.

NameDescription
System_CAPS_pubpropertyCanFreeze

Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)

System_CAPS_pubpropertyDependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyHasAnimatedProperties

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)

System_CAPS_pubpropertyIsFrozen

Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)

System_CAPS_pubpropertyIsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

System_CAPS_pubpropertyLocation

Gets or sets the vertical location at which the text decoration is drawn.

System_CAPS_pubpropertyPen

Gets or sets the Pen used to draw the text decoration.

System_CAPS_pubpropertyPenOffset

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

System_CAPS_pubpropertyPenOffsetUnit

Gets the units in which the PenOffset value is expressed.

System_CAPS_pubpropertyPenThicknessUnit

Gets the units in which the Thickness of the text decoration's Pen is expressed.

NameDescription
System_CAPS_pubmethodApplyAnimationClock(DependencyProperty, AnimationClock)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodBeginAnimation(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.)

System_CAPS_pubmethodBeginAnimation(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.)

System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodClearValue(DependencyProperty)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodClearValue(DependencyPropertyKey)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethodClone()

Creates a modifiable clone of this TextDecoration, making deep copies of this object's values.

System_CAPS_pubmethodCloneCurrentValue()

Creates a modifiable clone of this TextDecoration object, making deep copies of this object's current values.

System_CAPS_pubmethodCoerceValue(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.)

System_CAPS_pubmethodEquals(Object)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodFreeze()

Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)

System_CAPS_pubmethodGetAnimationBaseValue(DependencyProperty)

Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)

System_CAPS_pubmethodGetAsFrozen()

Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)

System_CAPS_pubmethodGetCurrentValueAsFrozen()

Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.(Inherited from Freezable.)

System_CAPS_pubmethodGetHashCode()

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetLocalValueEnumerator()

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty)

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodInvalidateProperty(DependencyProperty)

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_pubmethodReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetCurrentValue(DependencyProperty, Object)

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethodShouldSerializeProperty(DependencyProperty)

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticLocationProperty

Identifies the Location dependency property.

System_CAPS_pubfieldSystem_CAPS_staticPenOffsetProperty

Identifies the PenOffset dependency property.

System_CAPS_pubfieldSystem_CAPS_staticPenOffsetUnitProperty

Identifies the PenOffsetUnit dependency property.

System_CAPS_pubfieldSystem_CAPS_staticPenProperty

Identifies the Pen dependency property.

System_CAPS_pubfieldSystem_CAPS_staticPenThicknessUnitProperty

Identifies the PenThicknessUnit dependency property.

NameDescription
System_CAPS_pubeventChanged

Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

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.

Diagram of text decoration locations

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.

Text decoration with linear gradient underline

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.

.NET Framework
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.

Return to top
Show: