SdtAlias class

Office 2013 and later

Defines the SdtAlias Class. When the object is serialized out as xml, its qualified name is w:alias.

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

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

[ISO/IEC 29500-1 1st Edition]

alias (Friendly Name)

This element specifies the friendly name associated with the current structured document tag. The string representing the friendly name shall be stored on this element's val attribute.

If this element is omitted, then no friendly name shall be associated with the given structured document tag.

[Example: Consider the following properties on a structured document tag:

<w:sdtPr>
  <w:alias w:val="Birthday"/>
  …</w:sdtPr>

This set of properties specifies via the alias element that the friendly name for the parent structured document tag must be Birthday. end example]

Parent Elements

sdtPr (§17.5.2.38)

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.

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