Export (0) Print
Expand All

SdtProperties class

Structured Document Tag Properties. When the object is serialized out as xml, its qualified name is w:sdtPr.

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

[ChildElementInfoAttribute(typeof(SdtContentEquation))]
[ChildElementInfoAttribute(typeof(SdtRepeatedSectionItem), FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(SdtAlias))]
[ChildElementInfoAttribute(typeof(Lock))]
[ChildElementInfoAttribute(typeof(SdtPlaceholder))]
[ChildElementInfoAttribute(typeof(ShowingPlaceholder))]
[ChildElementInfoAttribute(typeof(DataBinding))]
[ChildElementInfoAttribute(typeof(DataBinding), FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(TemporarySdt))]
[ChildElementInfoAttribute(typeof(SdtId))]
[ChildElementInfoAttribute(typeof(Tag))]
[ChildElementInfoAttribute(typeof(Color), FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(Appearance), FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(WebExtensionLinked), FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(WebExtensionCreated), FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(RunProperties))]
[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.None|FileFormatVersions.Office2010|FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(SdtContentCheckBox), FileFormatVersions.None|FileFormatVersions.Office2010|FileFormatVersions.Office2013)]
[ChildElementInfoAttribute(typeof(SdtRepeatedSection), FileFormatVersions.Office2013)]
public class SdtProperties : OpenXmlCompositeElement

[ISO/IEC 29500-1 1st Edition]

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft