Aliases Class

Alternate Style Names.When the object is serialized out as xml, its qualified name is w:aliases.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.String253Type
        DocumentFormat.OpenXml.Wordprocessing.Aliases

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

Syntax

'Declaration
Public Class Aliases _
    Inherits String253Type
'Usage
Dim instance As Aliases
public class Aliases : String253Type

Remarks

[ISO/IEC 29500-1 1st Edition]

17.7.2.1 aliases (Alternate Style Names)

This element specifies the set of alternative names for the parent style definition. These names can be used in an application's user interface as desired. The alternate names shall be stored in this element's val attribute, and each name shall be separated by one or more consecutive comma characters (Unicode character value 002C). All commas present shall be interpreted as separator character and never as part of an alternate style name.

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

If this element is omitted, then the style shall not have any alternate style names.

[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 (§17.7.4.9), as well as two alternate names Regional Growth and Complex Growth using the aliases 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

Aliases Members

DocumentFormat.OpenXml.Wordprocessing Namespace