Underline Class

Underline Stroke.When the object is serialized out as xml, its qualified name is a:uLn.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Drawing.LinePropertiesType
        DocumentFormat.OpenXml.Drawing.Underline

Namespace:  DocumentFormat.OpenXml.Drawing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class Underline _
    Inherits LinePropertiesType
'Usage
Dim instance As Underline
public class Underline : LinePropertiesType

Remarks

The following table lists the possible child types:

  • NoFill <a:noFill>

  • SolidFill <a:solidFill>

  • GradientFill <a:gradFill>

  • PatternFill <a:pattFill>

  • PresetDash <a:prstDash>

  • CustomDash <a:custDash>

  • Round <a:round>

  • LineJoinBevel <a:bevel>

  • Miter <a:miter>

  • HeadEnd <a:headEnd>

  • TailEnd <a:tailEnd>

  • ExtensionList <a:extLst>

[ISO/IEC 29500-1 1st Edition]

21.1.2.3.14 uLn (Underline Stroke)

This element specifies the properties for the stroke of the underline that is present within a run of text.

[Example: Consider the DrawingML shown below.

<p:txBody>
…
<a:p>
<a:r>
<a:rPr …>
<a:uLn algn="r">
</a:rPr>
      …
<a:t>Sample Text</a:t>
…
</a:r>
</a:p>
…
</p:txBody>

The underline alignment of the above text is right aligned. end example]

Parent Elements

defRPr (§21.1.2.3.2); endParaRPr (§21.1.2.2.3); rPr (§21.1.2.3.9)

Child Elements

Subclause

bevel (Line Join Bevel)

§20.1.8.9

custDash (Custom Dash)

§20.1.8.21

extLst (Extension List)

§20.1.2.2.15

gradFill (Gradient Fill)

§20.1.8.33

headEnd (Line Head/End Style)

§20.1.8.38

miter (Miter Line Join)

§20.1.8.43

noFill (No Fill)

§20.1.8.44

pattFill (Pattern Fill)

§20.1.8.47

prstDash (Preset Dash)

§20.1.8.48

round (Round Line Join)

§20.1.8.52

solidFill (Solid Fill)

§20.1.8.54

tailEnd (Tail line end style)

§20.1.8.57

Attributes

Description

algn (Stroke Alignment)

Specifies the alignment to be used for the underline stroke.

The possible values for this attribute are defined by the ST_PenAlignment simple type (§20.1.10.39).

cap (Line Ending Cap Type)

Specifies the ending caps that should be used for this line. [Note: Examples of cap types are rounded, flat, etc. end note] If this attribute is omitted, than a value of square is assumed.

The possible values for this attribute are defined by the ST_LineCap simple type (§20.1.10.31).

cmpd (Compound Line Type)

Specifies the compound line type to be used for the underline stroke. If this attribute is omitted, then a value of sng is assumed.

The possible values for this attribute are defined by the ST_CompoundLine simple type (§20.1.10.15).

w (Line Width)

Specifies the width to be used for the underline stroke. If this attribute is omitted, then a value of 0 is assumed.

The possible values for this attribute are defined by the ST_LineWidth simple type (§20.1.10.35).

[Note: The W3C XML Schema definition of this element’s content model (CT_LineProperties) is located in §A.4.1. end note]

© ISO/IEC29500: 2008.

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

Underline Members

DocumentFormat.OpenXml.Drawing Namespace