StyleName Class

Primary Style Name.When the object is serialized out as xml, its qualified name is w:name.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.StyleName

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

Syntax

'Declaration
Public Class StyleName _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As StyleName
public class StyleName : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.7.2.9 name (Primary Style Name)

This element specifies the primary name for the current style in the document. This name can be used in an application's user interface as desired. The actual primary name for this style is stored in its val attribute.

If present, the alternate style names (§17.7.4.1) shall be used in the user interface in place of the built-in name specified when the appropriate value is set in the stylePaneFormatFilter element (§17.15.1.85).

If this element is omitted, then the style shall not have a primary style name.

[Example: Consider a style with a primary name and two alternate names, defined using the name and aliases elements, as follows:

<w:style w:styleId="TestStyle" … >
<w:name w:val="GD20Complex"/>
<w:aliases w:val="Regional Growth,Complex Growth"/>
…
</w:style>

This style specifies that it has the primary name GD20Complex using the name element. end example]

Parent Elements

style (§17.7.4.17)

Attributes

Description

val (String Value)

Specifies that its contents contain a string.

The contents of this string are interpreted based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment:

<w:pPr>
  <w:pStyle w:val="heading1" /> 
</w:pPr>

The value of the val attribute is the ID of the associated paragraph style's styleId.

However, consider the following fragment:

<w:sdtPr>
  <w:alias w:val="SDT Title Example" />
  …
</w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_String) is located in §A.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

StyleName Members

DocumentFormat.OpenXml.Wordprocessing Namespace