Underline Class (System.Windows.Documents)

MSDN Library
.NET Development
.NET Framework 3.5
.NET Framework Class Library
System.Windows.Documents Namespace

Underline Class

Underline Members
Underline Constructor
Underline Methods
Underline Properties
Underline Events

Underline Class
This page is specific to:.NET Framework Version: 3.03.54

.NET Framework Class Library

Underline Class

An inline-level flow content element which causes content to render with an underlined text decoration.

Namespace: System.Windows.Documents
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

Syntax

C++

JScript

Copy to Clipboard Print

'Usage

Dim instance As Underline

'Declaration

Public Class Underline _
    Inherits Span

XAML Object Element Usage

<Underline>
  Inlines
</Underline>

Examples

The following example demonstrates declarative usage for various flow content elements and associated attributes. Elements and attributes demonstrated include:

Bold element
BreakPageBefore attribute
FontSize attribute
Italic element
LineBreak element
List element
ListItem element
Paragraph element
Run element
Section element
Span element
Variants attribute (superscript and subscript)
Underline element

<FlowDocument 
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
>
    <Paragraph FontSize="18">Flow Format Example</Paragraph>

    <Paragraph>
      Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy 
      nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi 
      enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis 
      nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure.
    </Paragraph>
    <Paragraph>
      Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh 
      euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim 
      ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl 
      ut aliquip ex ea commodo consequat. Duis autem vel eum iriure.
    </Paragraph>

    <Paragraph FontSize="18">More flow elements</Paragraph>
    <Paragraph FontSize="15">Inline, font type and weight, and a List</Paragraph>

    <List>
      <ListItem><Paragraph>ListItem 1</Paragraph></ListItem>
      <ListItem><Paragraph>ListItem 2</Paragraph></ListItem>
      <ListItem><Paragraph>ListItem 3</Paragraph></ListItem>
      <ListItem><Paragraph>ListItem 4</Paragraph></ListItem>
      <ListItem><Paragraph>ListItem 5</Paragraph></ListItem>
    </List>

    <Paragraph><Bold>Bolded</Bold></Paragraph>
    <Paragraph><Underline>Underlined</Underline></Paragraph>
    <Paragraph><Bold><Underline>Bolded and Underlined</Underline></Bold></Paragraph>
    <Paragraph><Italic>Italic</Italic></Paragraph>

    <Paragraph><Span>The Span element, no inherent rendering</Span></Paragraph>
    <Paragraph><Run>The Run element, no inherent rendering</Run></Paragraph>    

    <Paragraph FontSize="15">Subscript, Superscript</Paragraph>

    <Paragraph>
      <Run Typography.Variants="Superscript">This text is Superscripted.</Run> This text isn't.
    </Paragraph>
    <Paragraph>
      <Run Typography.Variants="Subscript">This text is Subscripted.</Run> This text isn't.
    </Paragraph>
    <Paragraph>
      If a font does not support a particular form (such as Superscript) a default font form will be displayed.
    </Paragraph>

    <Paragraph FontSize="15">Blocks, breaks, paragraph</Paragraph>

    <Section><Paragraph>A block section of text</Paragraph></Section>
    <Section><Paragraph>Another block section of text</Paragraph></Section>

    <Paragraph><LineBreak/></Paragraph>
    <Section><Paragraph>... and another section, preceded by a LineBreak</Paragraph></Section>

    <Section BreakPageBefore="True"/>
    <Section><Paragraph>... and another section, preceded by a PageBreak</Paragraph></Section>

    <Paragraph>Finally, a paragraph. Note the break between this paragraph ...</Paragraph>
    <Paragraph TextIndent="25">... and this paragraph, and also the left indention.</Paragraph>

    <Paragraph><LineBreak/></Paragraph>

</FlowDocument>

Inheritance Hierarchy

System..::.Object
  System.Windows.Threading..::.DispatcherObject
    System.Windows..::.DependencyObject
      System.Windows..::.ContentElement
        System.Windows..::.FrameworkContentElement
          System.Windows.Documents..::.TextElement
            System.Windows.Documents..::.Inline
              System.Windows.Documents..::.Span
                System.Windows.Documents..::.Underline

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

Underline Members

System.Windows.Documents Namespace

Other Resources

Flow Document Overview

Flow Content Elements Samples