AltName Class

Alternate Names for Font.When the object is serialized out as xml, its qualified name is w:altName.

Inheritance Hierarchy

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

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

Syntax

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

Remarks

[ISO/IEC 29500-1 1st Edition]

17.8.3.1 altName (Alternate Names for Font)

This element specifies a set of alternative names which can be used to locate the font specified by the parent element. This set of alternative names is stored in a comma-delimited list, with all adjacent commas ignored (i.e. a value of Name A, Name B is equivalent to Name A,,,,,,,,, Name B).

When an application cannot locate a font using the primary name stored on the font attribute of the font element (§17.8.3.10), it should use each alternate name in term to attempt to locate the font, and use the first font for which is locates a match.

If this element is omitted, then no alternate names are present for the parent font.

[Example: Consider the following information stored for a single font:

<w:font w:name="SimSun">
<w:altName w:val="Arial Unicode MS" />
…
</w:font>

The altName element specifies that when no font with a name of SimSun (the primary font name) can be located, that applications should attempt to locate a font with the name Arial Unicode MS before doing substitution based on the font metrics. end example]

Parent Elements

font (§17.8.3.10)

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

AltName Members

DocumentFormat.OpenXml.Wordprocessing Namespace