SdtPlaceholder Class

Structured Document Tag Placeholder Text.When the object is serialized out as xml, its qualified name is w:placeholder.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Wordprocessing.SdtPlaceholder

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(DocPartReference))> _
Public Class SdtPlaceholder _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As SdtPlaceholder
[ChildElementInfoAttribute(typeof(DocPartReference))]
public class SdtPlaceholder : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • DocPartReference <w:docPart>

[ISO/IEC 29500-1 1st Edition]

17.5.2.25 placeholder (Structured Document Tag Placeholder Text)

This element specifies the placeholder text which should be displayed when this structured document tag's run contents are empty, the associated mapped XML element is empty as specified via the dataBinding element (§17.5.2.6) or the showingPlcHdr element (§17.5.2.39) is set in the structured document tag's properties. The placeholder text which shall be shown is itself specified via the child element docPart.

If this element is omitted, then five non-breaking spaces shall be used as the default placeholder text for this structured document tag.

[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 placeholder element that its placeholder text must be specified in the document part of type bbPlcHdr whose name is equal to DefaultPlaceholder_22610170. end example]

Parent Elements

sdtPr (§17.5.2.38)

Child Elements

Subclause

docPart (Document Part Reference)

§17.5.2.9

[Note: The W3C XML Schema definition of this element’s content model (CT_Placeholder) 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

SdtPlaceholder Members

DocumentFormat.OpenXml.Wordprocessing Namespace