DocPartReference class

Office 2013 and later

Document Part Reference. When the object is serialized out as xml, its qualified name is w:docPart.

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

public class DocPartReference : StringType

[ISO/IEC 29500-1 1st Edition]

docPart (Document Part Reference)

This element specifies the name of the document part which shall be displayed in the parent structured document tag when its run contents are empty. If this element is specified, then a document part whose name element (§17.12.12) specifies a name matching the value of this element, and which belongs to the bbPlcHdr style shall be located to be used as the placeholder text for the parent structured document tag.

If no document part is located matching the criteria specified by this element, then five non-breaking spaces shall be used as the default placeholder text.

[Example: Consider a structured document tag defined as follows:

<w:sdt>
  <w:sdtPr>
    <w:placeholder>
      <w:docPart w:val="DefaultPlaceholder_22610170" /> 
    </w:placeholder>
    …  </w:sdtPr>
  <w:sdtContent>
  …  </w:sdtContent>
</w:sdt>

This structured document tag specifies through the docPart element that its placeholder text must be specified in the document part of style bbPlcHdr whose name is equal to DefaultPlaceholder_22610170. end example]

Parent Elements

placeholder (§17.5.2.25)

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: