FormControlProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines the FormControlProperties Class.
This class is available in Office 2010 and above.
When the object is serialized out as xml, it's qualified name is x14:formControlPr.
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ListItems), DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ExtensionList), DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
[DocumentFormat.OpenXml.SchemaAttr(53, "formControlPr")]
public class FormControlProperties : DocumentFormat.OpenXml.OpenXmlPartRootElementpublic class FormControlProperties : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.SchemaAttr(53, "formControlPr")]
public class FormControlProperties : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.SchemaAttr("x14:formControlPr")]
public class FormControlProperties : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.SchemaAttr("x14:formControlPr")]
public class FormControlProperties : DocumentFormat.OpenXml.TypedOpenXmlPartRootElement[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ListItems), DocumentFormat.OpenXml.FileFormatVersions.Office2010 | DocumentFormat.OpenXml.FileFormatVersions.Office2013)]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ExtensionList), DocumentFormat.OpenXml.FileFormatVersions.Office2010 | DocumentFormat.OpenXml.FileFormatVersions.Office2013)]
public class FormControlProperties : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ListItems), DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ExtensionList), DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
public class FormControlProperties : DocumentFormat.OpenXml.OpenXmlPartRootElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ListItems), DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ExtensionList), DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
[<DocumentFormat.OpenXml.SchemaAttr(53, "formControlPr")>]
type FormControlProperties = class
inherit OpenXmlPartRootElementtype FormControlProperties = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.SchemaAttr(53, "formControlPr")>]
type FormControlProperties = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.SchemaAttr("x14:formControlPr")>]
type FormControlProperties = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.SchemaAttr("x14:formControlPr")>]
type FormControlProperties = class
inherit TypedOpenXmlPartRootElement[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ListItems), DocumentFormat.OpenXml.FileFormatVersions.Office2010 | DocumentFormat.OpenXml.FileFormatVersions.Office2013)>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ExtensionList), DocumentFormat.OpenXml.FileFormatVersions.Office2010 | DocumentFormat.OpenXml.FileFormatVersions.Office2013)>]
type FormControlProperties = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ListItems), DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2010.Excel.ExtensionList), DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
type FormControlProperties = class
inherit OpenXmlPartRootElementPublic Class FormControlProperties
Inherits OpenXmlPartRootElementPublic Class FormControlProperties
Inherits TypedOpenXmlPartRootElement- Inheritance
- Inheritance
-
FormControlProperties
- Attributes
Remarks
2.4.34 formControlPr
Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main
A formControlPr element is a CT_FormControlPr type element, as specified in section 2.6.65, that specifies properties of form control objects. This element is the root element of the control properties part, as specified in section 2.1.1.
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.
<xsd:element name="formControlPr" type="CT_FormControlPr"/>
See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
2.6.65 CT_FormControlPr
Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main
Referenced by: formControlPr
A complex type that stores a form control’s properties.
Child Elements:
itemLst: A CT_ListItems element, as specified in section 2.6.64, that specifies a list of items to populate a list box or drop-down form control.
extLst: A CT_ExtensionList element, as specified in [ISO/IEC-29500-4] section A.2, that specifies future extensibility for this element.
Attributes:
objectType: An ST_ObjectType attribute that specifies the form control object type.
checked: An ST_Checked attribute that specifies whether a check box is selected or a radio button is selected. This attribute only applies to check box and radio button form controls.
colored: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether a drop-down object has a color applied to it. This attribute only applies to drop-down form controls.
dropLines: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the number of lines in the drop-down before scroll bars are added. This attribute only applies to drop-down form controls. This value MUST be at least 0 and at most 30000.
dropStyle: An ST_DropStyle attribute that specifies the style of the drop-down. This attribute only applies to drop-down form controls.
dx: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the width of the scroll bar in pixels. This attribute only applies to list boxes, scroll bars, spin boxes and drop-downs<55>.
firstButton: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the object is the first button in a set of radio buttons. This attribute only applies to radio button form controls.
fmlaGroup: An ST_Formula ([ISO/IEC-29500-1] section 18.18.35) attribute that specifies the cell an object in a group box is linked to. This attribute overrides the attribute fmlaLink for any radio buttons within a group box. This attribute only applies to group box form controls. The application can chose to remove and not save this element and use the attribute fmlaLink of the first radio button in the group. This attribute MUST be a cell reference (see [ISO/IEC-29500-1] section 18.17.2.3).
fmlaLink: An ST_Formula ([ISO/IEC-29500-1] section 18.18.35) attribute that specifies the cell the object is linked to. This attribute only applies to check boxes, radio buttons, scroll bars, spin boxes, drop-downs and list boxes. The value in the linked cell and the index of the selected item in the object are linked together. This link is ignored if the form control allows multiple selections. This attribute MUST be a cell reference (see [ISO/IEC-29500-1] section 18.17.2.3).
fmlaRange: An ST_Formula ([ISO/IEC-29500-1] section 18.18.35) attribute that specifies the range of source data cells. This is used to populate a list box or a drop-down form control<56>. This attribute only applies to list box and drop-down form controls. This attribute MUST be a cell reference (see [ISO/IEC-29500-1] section 18.17.2.3).
fmlaTxbx: An ST_Formula ([ISO/IEC-29500-1] section 18.18.35) attribute that specifies the source data cell that the form control object’s data is linked to. Any cell range MAY be specified but only the first cell in the range is considered. This attribute applies only to label and edit box form controls. This attribute MUST be a cell reference (see [ISO/IEC-29500-1] section 18.17.2.3).
horiz: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the scroll bar is horizontal. This attribute only applies to scroll bar form controls.
inc: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the change in the current value of a scroll bar or a spin box form control as a result of on an increment click. If present, it MUST be at least 0 and at most 30000. This attribute applies only to scroll bar or spin box form controls.
justLastX: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the last line in text is justified when in an East Asian alignment<57>.
lockText: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the object’s text is locked. This attribute applies only to button, radio button, check box and label form controls.
max: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the maximum value generated by the scroll bar (when scrolled all the way down) or by the spin box. It MUST be at least 0 and at most 30000. This attribute only applies to scroll bars and spin boxes.
min: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the minimum value generated by the scroll bar (when scrolled all the way up) or by the spin box. It MUST be at least 0 and at most 30000. This attribute only applies to scroll bars and spin box.
multiSel: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the indices of selected items as a comma-delimited list. The list indices are one-based. This attribute is valid only if the attribute selType has the value "multi". This attribute applies only to list box form controls.
noThreeD: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether 3-D effects are disabled. This attribute only applies to check box, radio button, group box, scroll bar, drop-down, list box, and spin box form controls.
noThreeD2: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether 3-D effects are disabled. This element is used for drop-downs and list boxes<58>.
page: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the number of items to move the scroll bar or spin box on a page click. It MUST be at least 0 and at most 30000<59>.
sel: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the index of the selected item. The list indices are one-based. If set to a value of 0, no items are selected. This attribute applies only to list box and drop-down form controls.
seltype: An ST_SelType attribute that specifies the selection type for the list box. This attribute applies only to list box form controls.
textHAlign: An ST_TextHAlign attribute that specifies the horizontal text alignment for the object<60>.
textVAlign: An ST_TextVAlign attribute that specifies the vertical text alignment for the object<61>.
val: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the number of top rows (2) currently hidden in the scroll bar. If omitted, the value is assumed to be 0. Those rows (2) are hidden but still accessible by clicking the scroll bar buttons. The number of top hidden rows (2) can change as the user interacts with the scroll bar. This attribute only applies to scroll bar, spin box, list box, and drop-down form controls.
widthMin: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the smallest width allowed for the drop-down box window in screen pixels. This attribute only applies for drop-down form controls.
editVal: An ST_EditValidation attribute that specifies how the edit box content is validated if the application chooses to validate it. This attribute only applies to edit box form controls.
multiLine: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the form control is multiline. This attribute only applies to edit box form controls. This attribute only works when the form control is run in a dialog box.
verticalBar: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the control has a vertical scroll bar. This attribute only applies to edit box form controls. This attribute only works when the form control is run in a dialog box.
passwordEdit: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the edit box control stores a password. In this case the control will display * for every character on it. This attribute only applies to edit box form controls. This attribute only works when the control is run in a dialog box.
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.
<xsd:complexType name="CT_FormControlPr">
<xsd:sequence>
<xsd:element name="itemLst" type="CT_ListItems" minOccurs="0" maxOccurs="1"/>
<xsd:element name="extLst" type="x:CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="objectType" type="ST_ObjectType" use="optional"/>
<xsd:attribute name="checked" type="ST_Checked" use="optional"/>
<xsd:attribute name="colored" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="dropLines" type="xsd:unsignedInt" use="optional" default="8"/>
<xsd:attribute name="dropStyle" type="ST_DropStyle" use="optional"/>
<xsd:attribute name="dx" type="xsd:unsignedInt" use="optional" default="80"/>
<xsd:attribute name="firstButton" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="fmlaGroup" type="x:ST_Formula" use="optional"/>
<xsd:attribute name="fmlaLink" type="x:ST_Formula" use="optional"/>
<xsd:attribute name="fmlaRange" type="x:ST_Formula" use="optional"/>
<xsd:attribute name="fmlaTxbx" type="x:ST_Formula" use="optional"/>
<xsd:attribute name="horiz" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="inc" type="xsd:unsignedInt" use="optional" default="1"/>
<xsd:attribute name="justLastX" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="lockText" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="max" type="xsd:unsignedInt" use="optional"/>
<xsd:attribute name="min" type="xsd:unsignedInt" use="optional" default="0"/>
<xsd:attribute name="multiSel" type="xsd:string" use="optional"/>
<xsd:attribute name="noThreeD" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="noThreeD2" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="page" type="xsd:unsignedInt" use="optional"/>
<xsd:attribute name="sel" type="xsd:unsignedInt" use="optional"/>
<xsd:attribute name="seltype" type="ST_SelType" use="optional" default="single"/>
<xsd:attribute name="textHAlign" type="ST_TextHAlign" use="optional" default="left"/>
<xsd:attribute name="textVAlign" type="ST_TextVAlign" use="optional" default="top"/>
<xsd:attribute name="val" type="xsd:unsignedInt" use="optional"/>
<xsd:attribute name="widthMin" type="xsd:unsignedInt" use="optional"/>
<xsd:attribute name="editVal" type="ST_EditValidation" use="optional"/>
<xsd:attribute name="multiLine" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="verticalBar" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="passwordEdit" type="xsd:boolean" use="optional" default="false"/>
</xsd:complexType>
See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
Constructors
| FormControlProperties() |
Initializes a new instance of the FormControlProperties class. |
| FormControlProperties(IEnumerable<OpenXmlElement>) |
Initializes a new instance of the FormControlProperties class with the specified child elements. |
| FormControlProperties(OpenXmlElement[]) |
Initializes a new instance of the FormControlProperties class with the specified child elements. |
| FormControlProperties(String) |
Initializes a new instance of the FormControlProperties class from outer XML. |
Properties
| Checked |
checked, this property is only available in Office 2010 and later. Represents the following attribute in the schema: checked |
| ChildElements |
Gets all the child nodes of the current element. (Inherited from OpenXmlElement) |
| Colored |
colored, this property is only available in Office 2010 and later. Represents the following attribute in the schema: colored |
| ControlPropertiesPart |
Gets the ControlPropertiesPart associated with this element. |
| DropLines |
dropLines, this property is only available in Office 2010 and later. Represents the following attribute in the schema: dropLines |
| DropStyle |
dropStyle, this property is only available in Office 2010 and later. Represents the following attribute in the schema: dropStyle |
| EditVal |
editVal, this property is only available in Office 2010 and later. Represents the following attribute in the schema: editVal |
| ExtendedAttributes |
Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement) |
| ExtensionList |
ExtensionList. Represents the following element tag in the schema: x14:extLst. |
| Features |
Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement) |
| FirstButton |
firstButton, this property is only available in Office 2010 and later. Represents the following attribute in the schema: firstButton |
| FirstChild |
Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement) |
| FmlaGroup |
fmlaGroup, this property is only available in Office 2010 and later. Represents the following attribute in the schema: fmlaGroup |
| FmlaLink |
fmlaLink, this property is only available in Office 2010 and later. Represents the following attribute in the schema: fmlaLink |
| FmlaRange |
fmlaRange, this property is only available in Office 2010 and later. Represents the following attribute in the schema: fmlaRange |
| FmlaTextbox |
fmlaTxbx, this property is only available in Office 2010 and later. Represents the following attribute in the schema: fmlaTxbx |
| HasAttributes |
Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement) |
| HasChildren |
Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement) |
| Horizontal |
horiz, this property is only available in Office 2010 and later. Represents the following attribute in the schema: horiz |
| Incremental |
inc, this property is only available in Office 2010 and later. Represents the following attribute in the schema: inc |
| InnerText |
Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement) |
| InnerXml |
Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement) |
| JustLastX |
justLastX, this property is only available in Office 2010 and later. Represents the following attribute in the schema: justLastX |
| LastChild |
Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement) |
| ListItems |
ListItems. Represents the following element tag in the schema: x14:itemLst. |
| LocalName | |
| LocalName |
Gets the local name of the current element. (Inherited from OpenXmlElement) |
| LockText |
lockText, this property is only available in Office 2010 and later. Represents the following attribute in the schema: lockText |
| Max |
max, this property is only available in Office 2010 and later. Represents the following attribute in the schema: max |
| MCAttributes |
Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement) |
| Min |
min, this property is only available in Office 2010 and later. Represents the following attribute in the schema: min |
| MinimumWidth |
widthMin, this property is only available in Office 2010 and later. Represents the following attribute in the schema: widthMin |
| MultipleLines |
multiLine, this property is only available in Office 2010 and later. Represents the following attribute in the schema: multiLine |
| MultipleSelection |
multiSel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: multiSel |
| NamespaceDeclarations |
Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement) |
| NamespaceUri |
Gets the namespace URI of the current element. (Inherited from OpenXmlElement) |
| NoThreeD |
noThreeD, this property is only available in Office 2010 and later. Represents the following attribute in the schema: noThreeD |
| NoThreeD2 |
noThreeD2, this property is only available in Office 2010 and later. Represents the following attribute in the schema: noThreeD2 |
| ObjectType |
objectType, this property is only available in Office 2010 and later. Represents the following attribute in the schema: objectType |
| OpenXmlElementContext |
Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement) |
| OpenXmlPart |
Gets the part that is associated with the DOM tree. It returns null when the DOM tree is not associated with a part. (Inherited from OpenXmlPartRootElement) |
| OuterXml |
Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement) |
| Page |
page, this property is only available in Office 2010 and later. Represents the following attribute in the schema: page |
| Parent |
Gets the parent element of the current element. (Inherited from OpenXmlElement) |
| PasswordEdit |
passwordEdit, this property is only available in Office 2010 and later. Represents the following attribute in the schema: passwordEdit |
| Prefix |
Gets the namespace prefix of current element. (Inherited from OpenXmlElement) |
| ScrollBarWidth |
dx, this property is only available in Office 2010 and later. Represents the following attribute in the schema: dx |
| Selected |
sel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: sel |
| SelectionType |
seltype, this property is only available in Office 2010 and later. Represents the following attribute in the schema: seltype |
| TextHorizontalAlign |
textHAlign, this property is only available in Office 2010 and later. Represents the following attribute in the schema: textHAlign |
| TextVerticalAlign |
textVAlign, this property is only available in Office 2010 and later. Represents the following attribute in the schema: textVAlign |
| Val |
val, this property is only available in Office 2010 and later. Represents the following attribute in the schema: val |
| VerticalBar |
verticalBar, this property is only available in Office 2010 and later. Represents the following attribute in the schema: verticalBar |
| XmlQualifiedName |
Gets the qualified name of the current element. (Inherited from OpenXmlElement) |
| XName |
Gets the qualified name of the current element. (Inherited from OpenXmlElement) |
Methods
| AddAnnotation(Object) |
Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement) |
| AddChild(OpenXmlElement, Boolean) |
Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement) |
| AddNamespaceDeclaration(String, String) |
Adds a namespace declaration to the current node. (Inherited from OpenXmlElement) |
| Ancestors() |
Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement) |
| Ancestors<T>() |
Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement) |
| Annotation(Type) |
Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotation<T>() |
Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotations(Type) |
Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotations<T>() |
Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Append(IEnumerable<OpenXmlElement>) |
Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement) |
| Append(OpenXmlElement[]) |
Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement) |
| AppendChild<T>(T) |
Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement) |
| ClearAllAttributes() |
Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement) |
| Clone() |
Creates a duplicate of the current node. (Inherited from OpenXmlElement) |
| CloneNode(Boolean) |
Creates a duplicate of this node. |
| Descendants() |
Enumerates all of the current element's descendants. (Inherited from OpenXmlElement) |
| Descendants<T>() |
Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement) |
| Elements() |
Enumerates all of the current element's children. (Inherited from OpenXmlElement) |
| Elements<T>() |
Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement) |
| ElementsAfter() |
Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement) |
| ElementsBefore() |
Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement) |
| GetAttribute(String, String) |
Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement) |
| GetAttributes() |
Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement) |
| GetEnumerator() |
Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement) |
| GetFirstChild<T>() |
Finds the first child element in type T. (Inherited from OpenXmlElement) |
| InsertAfter<T>(T, OpenXmlElement) |
Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement) |
| InsertAfterSelf<T>(T) |
Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement) |
| InsertAt<T>(T, Int32) |
Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement) |
| InsertBefore<T>(T, OpenXmlElement) |
Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement) |
| InsertBeforeSelf<T>(T) |
Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement) |
| IsAfter(OpenXmlElement) |
Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement) |
| IsBefore(OpenXmlElement) |
Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement) |
| Load(ControlPropertiesPart) |
Loads the DOM from the ControlPropertiesPart |
| LookupNamespace(String) |
Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement) |
| LookupPrefix(String) |
Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement) |
| NextSibling() |
Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement) |
| NextSibling<T>() |
Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement) |
| PrependChild<T>(T) |
Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement) |
| PreviousSibling() |
Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement) |
| PreviousSibling<T>() |
Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement) |
| Reload() |
Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement) |
| Remove() |
Removes the current element from its parent. (Inherited from OpenXmlElement) |
| RemoveAllChildren() |
Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement) |
| RemoveAllChildren<T>() |
Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement) |
| RemoveAnnotations(Type) |
Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| RemoveAnnotations<T>() |
Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| RemoveAttribute(String, String) |
Removes the attribute from the current element. (Inherited from OpenXmlElement) |
| RemoveChild<T>(T) |
Removes the specified child element. (Inherited from OpenXmlCompositeElement) |
| RemoveNamespaceDeclaration(String) |
Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement) |
| ReplaceChild<T>(OpenXmlElement, T) |
Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement) |
| Save() |
Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement) |
| Save(ControlPropertiesPart) |
Saves the DOM into the ControlPropertiesPart. |
| Save(Stream) |
Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement) |
| SetAttribute(OpenXmlAttribute) |
Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement) |
| SetAttributes(IEnumerable<OpenXmlAttribute>) |
Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement) |
| WriteTo(XmlWriter) |
Saves the current node to the specified XmlWriter. (Inherited from OpenXmlPartRootElement) |
Explicit Interface Implementations
| IEnumerable.GetEnumerator() | (Inherited from OpenXmlElement) |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement) |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for