SdtProperties Class
Structured Document Tag Properties.When the object is serialized out as xml, its qualified name is w:sdtPr.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Wordprocessing.SdtProperties
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(RunProperties))> _
<ChildElementInfoAttribute(GetType(SdtAlias))> _
<ChildElementInfoAttribute(GetType(Lock))> _
<ChildElementInfoAttribute(GetType(SdtPlaceholder))> _
<ChildElementInfoAttribute(GetType(ShowingPlaceholder))> _
<ChildElementInfoAttribute(GetType(DataBinding))> _
<ChildElementInfoAttribute(GetType(TemporarySdt))> _
<ChildElementInfoAttribute(GetType(SdtId))> _
<ChildElementInfoAttribute(GetType(Tag))> _
<ChildElementInfoAttribute(GetType(SdtContentEquation))> _
<ChildElementInfoAttribute(GetType(SdtContentComboBox))> _
<ChildElementInfoAttribute(GetType(SdtContentDate))> _
<ChildElementInfoAttribute(GetType(SdtContentDocPartObject))> _
<ChildElementInfoAttribute(GetType(SdtContentDocPartList))> _
<ChildElementInfoAttribute(GetType(SdtContentDropDownList))> _
<ChildElementInfoAttribute(GetType(SdtContentPicture))> _
<ChildElementInfoAttribute(GetType(SdtContentRichText))> _
<ChildElementInfoAttribute(GetType(SdtContentText))> _
<ChildElementInfoAttribute(GetType(SdtContentCitation))> _
<ChildElementInfoAttribute(GetType(SdtContentGroup))> _
<ChildElementInfoAttribute(GetType(SdtContentBibliography))> _
<ChildElementInfoAttribute(GetType(EntityPickerEmpty), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(SdtContentCheckBox), FileFormatVersions.Office2010)> _
Public Class SdtProperties _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As SdtProperties
[ChildElementInfoAttribute(typeof(RunProperties))]
[ChildElementInfoAttribute(typeof(SdtAlias))]
[ChildElementInfoAttribute(typeof(Lock))]
[ChildElementInfoAttribute(typeof(SdtPlaceholder))]
[ChildElementInfoAttribute(typeof(ShowingPlaceholder))]
[ChildElementInfoAttribute(typeof(DataBinding))]
[ChildElementInfoAttribute(typeof(TemporarySdt))]
[ChildElementInfoAttribute(typeof(SdtId))]
[ChildElementInfoAttribute(typeof(Tag))]
[ChildElementInfoAttribute(typeof(SdtContentEquation))]
[ChildElementInfoAttribute(typeof(SdtContentComboBox))]
[ChildElementInfoAttribute(typeof(SdtContentDate))]
[ChildElementInfoAttribute(typeof(SdtContentDocPartObject))]
[ChildElementInfoAttribute(typeof(SdtContentDocPartList))]
[ChildElementInfoAttribute(typeof(SdtContentDropDownList))]
[ChildElementInfoAttribute(typeof(SdtContentPicture))]
[ChildElementInfoAttribute(typeof(SdtContentRichText))]
[ChildElementInfoAttribute(typeof(SdtContentText))]
[ChildElementInfoAttribute(typeof(SdtContentCitation))]
[ChildElementInfoAttribute(typeof(SdtContentGroup))]
[ChildElementInfoAttribute(typeof(SdtContentBibliography))]
[ChildElementInfoAttribute(typeof(EntityPickerEmpty), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(SdtContentCheckBox), FileFormatVersions.Office2010)]
public class SdtProperties : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
RunProperties <w:rPr>
SdtAlias <w:alias>
Lock <w:lock>
SdtPlaceholder <w:placeholder>
ShowingPlaceholder <w:showingPlcHdr>
DataBinding <w:dataBinding>
TemporarySdt <w:temporary>
SdtId <w:id>
Tag <w:tag>
SdtContentEquation <w:equation>
SdtContentComboBox <w:comboBox>
SdtContentDate <w:date>
SdtContentDocPartObject <w:docPartObj>
SdtContentDocPartList <w:docPartList>
SdtContentDropDownList <w:dropDownList>
SdtContentPicture <w:picture>
SdtContentRichText <w:richText>
SdtContentText <w:text>
SdtContentCitation <w:citation>
SdtContentGroup <w:group>
SdtContentBibliography <w:bibliography>
DocumentFormat.OpenXml.Office2010.Word.EntityPickerEmpty <w14:entityPicker>
DocumentFormat.OpenXml.Office2010.Word.SdtContentCheckBox <w14:checkbox>
[ISO/IEC 29500-1 1st Edition]
17.5.2.38 sdtPr (Structured Document Tag Properties)
This element specifies the set of properties which shall be applied to the parent structured document tag.
[Example: Consider a structured document tag with the following properties specified:
<w:sdtPr> <w:alias w:val="Birthday"/> <w:id w:val="8775518"/> <w:date> <w:dateFormat w:val="M/d/yyyy"/> <w:lid w:val="EN-US"/> </w:date> </w:sdtPr>
This structured document tag specifies three properties: the a friendly name of Birthday via the alias element (§17.5.2.1), a unique ID of 8775518 via the id element (§17.5.2.18), and a structured document tag type of date picker via the date element (§17.5.2.7) which itself has a set of date-specific properties. end example]
Parent Elements |
|---|
sdt (§17.5.2.29); sdt (§17.5.2.32); sdt (§17.5.2.30); sdt (§17.5.2.31) |
Child Elements |
Subclause |
|---|---|
alias (Friendly Name) |
§17.5.2.1 |
bibliography (Bibliography Structured Document Tag) |
§17.5.2.2 |
citation (Citation Structured Document Tag) |
§17.5.2.4 |
comboBox (Combo Box Structured Document Tag) |
§17.5.2.5 |
dataBinding (XML Mapping) |
§17.5.2.6 |
date (Date Structured Document Tag) |
§17.5.2.7 |
docPartList (Document Part Gallery Structured Document Tag) |
§17.5.2.12 |
docPartObj (Built-In Document Part Structured Document Tag) |
§17.5.2.13 |
dropDownList (Drop-Down List Structured Document Tag) |
§17.5.2.15 |
equation (Equation Structured Document Tag) |
§17.5.2.16 |
group (Group Structured Document Tag) |
§17.5.2.17 |
id (Unique ID) |
§17.5.2.18 |
label (Structured Document Tag Label) |
§17.5.2.19 |
lock (Locking Setting) |
§17.5.2.23 |
picture (Picture Structured Document Tag) |
§17.5.2.24 |
placeholder (Structured Document Tag Placeholder Text) |
§17.5.2.25 |
richText (Rich Text Structured Document Tag) |
§17.5.2.26 |
rPr (Run Properties For Structured Document Tag Contents) |
§17.5.2.27 |
showingPlcHdr (Current Contents Are Placeholder Text) |
§17.5.2.39 |
tabIndex (Structured Document Tag Navigation Order Index) |
§17.5.2.41 |
tag (Programmatic Tag) |
§17.5.2.42 |
temporary (Remove Structured Document Tag When Contents Are Edited) |
§17.5.2.43 |
text (Plain Text Structured Document Tag) |
§17.5.2.44 |
[Note: The W3C XML Schema definition of this element’s content model (CT_SdtPr) 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.