TextDecorationCollection Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides the value for the TextBlock.TextDecorations and Inline.TextDecorations properties.

Inheritance Hierarchy

System.Object
  System.Windows.TextDecorationCollection

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

Syntax

'Declaration
Public NotInheritable Class TextDecorationCollection
public sealed class TextDecorationCollection
<object property="textDecorationsPropertyName"/>

XAML Values

  • textDecorationsPropertyName
    A string that names a static property with a value of type TextDecorations. In Silverlight 5, the only supported values are Underline or an empty string. Underline specifies an underline text decoration. The empty string specifies no text decoration, which is the default value for existing TextDecorations properties that use TextDecorationCollection. Setting to the empty string is not typically necessary, but it is supported.

The TextDecorationCollection type exposes the following members.

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

A text decoration is a visual ornament that you can add to text. In WPF, you can define custom text decorations. In Silverlight 5, there is one type of text decoration: Underline. The name of this object and its corresponding properties (TextDecorationCollection) is therefore something of a misnomer, but exists in this manner for Silverlight/WPF compatibility. The TextDecorationCollection class does not define any members.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference