Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Underline Class

Provides an inline-level content element that causes content to render with an underlined text decoration.

Namespace:  System.Windows.Documents
Assembly:  System.Windows (in System.Windows.dll)
public sealed class Underline : Span
<Underline ...>text</Underline>

The Underline type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneUnderlineInitializes a new instance of the Underline class.
Top
  NameDescription
Public propertyCharacterSpacingGets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneContentEndGets a TextPointer that represents the end of the content in the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneContentStartGets a TextPointer that represents the start of content in the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertySupported by Silverlight for Windows PhoneElementEndGets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneElementStartGets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontFamilyGets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontSizeGets or sets the font size for the content of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontStretchGets or sets the glyph width of the font in a family to select. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontStyleGets or sets the font style for the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneFontWeightGets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneForegroundGets or sets the Brush to apply to the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneInlinesGets an InlineCollection containing the top-level inline elements that include the contents of Span. (Inherited from Span.)
Public propertySupported by Silverlight for Windows PhoneLanguageGets or sets the language of the content within an TextElement element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneNameGets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows PhoneTextDecorationsGets or sets a value that specifies the text decorations that are applied to the content in an Inline element. (Inherited from Inline.)
Top
  NameDescription
Public methodSupported by Silverlight for Windows PhoneCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows 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 PhoneFindNameGets an object in the Silverlight object model by referencing the object's x:Name or Name attribute value. (Inherited from TextElement.)
Public methodSupported by Silverlight for Windows PhoneGetAnimationBaseValueReturns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneOnCreateAutomationPeerReturns a class-specific AutomationPeer implementation for use by the Silverlight automation infrastructure. (Inherited from TextElement.)
Public methodSupported by Silverlight for Windows PhoneReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The following code shows how you can apply underline formatting to the selected content in a RichTextBox.

Run this sample


//Set Underline formatting to selected content
private void BtnUnderline_Click(object sender, RoutedEventArgs e)
{
    if (MyRTB != null)
    {
        if (MyRTB.Selection.GetPropertyValue(Run.TextDecorationsProperty) == null)
            MyRTB.Selection.ApplyPropertyValue(Run.TextDecorationsProperty, TextDecorations.Underline);
        else
            MyRTB.Selection.ApplyPropertyValue(Run.TextDecorationsProperty, null);
    }

}


Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

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

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.