DocPartName Class
Entry 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.DocPartName
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class DocPartName _
Inherits OpenXmlLeafElement
'Usage
Dim instance As DocPartName
public class DocPartName : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.12.13 name (Entry Name)
This element specifies a name for the contents of this glossary document entry. This name can contain any string content, and allows the entry to have a friendly identifier contained within the definition for this glossary document entry. [Note: This name can be surfaced in a user interface, for example. end note]
[Example: Consider the following WordprocessingML fragment for the properties of a single glossary document entry:
<w:docPartPr> … <w:name w:val="Sample Entry" /> <w:description w:val="This is an example of a glossary document entry for example purposes." /> … </w:docPartPr>
The name element specifies that the friendly name associated with the parent entry must be Sample Entry. This value can be used as needed by an application, for example, to display in a user interface. end example]
Parent Elements |
|---|
docPartPr (§17.12.7) |
Attributes |
Description |
|---|---|
decorated (Built-In Entry) |
Specifies that the name for the current entry is a built-in entry which should not be displayed in the user interface. [Note: This information can be used by an application as needed, for example, to disambiguate an entry from one with the same name, ensuring that the built-in entry can be uniquely identified by the application. end note] If this attribute is omitted, its value shall be assumed to be false. [Example: Consider the following WordprocessingML fragment for the name of a single glossary document entry: <w:name w:decorated="true" w:val=":-)" /> The decorated attribute specifies that the parent entry is a built-in entry, and must be treated as such. end example] The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
val (Name Value) |
Specifies a string value which contains the name of the current glossary document entry. [Example: Consider the following WordprocessingML fragment for the name of a single glossary document entry: <w:name w:val="Sample Entry" /> The val attribute specifies that the name of the parent entry is Sample Entry. 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_DocPartName) 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.