Button Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.CustomUI

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the Button Class.

This class is available in Office 2010 and above.

When the object is serialized out as xml, it's qualified name is mso14:button.

public class Button : DocumentFormat.OpenXml.OpenXmlLeafElement

type Button = class
    inherit OpenXmlLeafElement

Public Class Button
Inherits OpenXmlLeafElement

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

Button

Remarks

2.3.24 CT_Button

Target namespace: http://schemas.microsoft.com/office/2009/07/customui

Referenced by: CT_ControlClone, CT_Box, CT_Group

Specifies a standard push-button control.

Attributes:

size: An ST_Size attribute, as specified in section 2.4.18, that specifies the size of this control. The size and getSize attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to the normal size.

getSize: An ST_Delegate attribute, as specified in section 2.4.7, that specifies the name of a callback function that is called to determine the size of this control. The size and getSize attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to the normal size.

onAction: An ST_Delegate attribute, as specified in section 2.4.7, that specifies the name of a callback function that is called when this control is invoked by the user.

enabled: A Boolean attribute that specifies the enabled state of this control. The enabled and getEnabled attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to being enabled.

getEnabled: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the enabled state of this control. The enabled and getEnabled attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to being enabled.

description: An ST_LongString attribute, as specified in section 2.4.16, that specifies a string that is displayed as the description of the control in detailed views. The description and getDescription attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a detailed description is not displayed.

getDescription: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the detailed description of this control. The description and getDescription attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a detailed description is not displayed.

image: An ST_Uri attribute, as specified in section 2.4.23, that specifies the relationship identifier of an image file that is used as the icon for this control. The image, getImage, and imageMso attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, an icon is not displayed.

imageMso: An ST_ID attribute, as specified in section 2.4.12, that specifies the identifier of a built-in image that is used as the icon for this control. The image, getImage, and imageMso attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, an icon is not displayed.

getImage: An ST_Delegate attribute, as specified in section 2.4.7, that specifies the name of a callback function that is called to determine the icon of this control. The image, getImage, and imageMso attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, an icon is not displayed.

id: An ST_UniqueID attribute, as specified in section 2.4.22, that specifies the identifier of a custom control. All custom controls MUST have unique identifiers. The id, idQ, and idMso attributes are mutually exclusive. Exactly one of these attributes MUST be specified on all controls.

idQ: An ST_QID attribute, as specified in section 2.4.17, that specifies the qualified identifier of a control. This attribute is used to reference controls or containers created by other Custom UI documents. The id, idQ, and idMso attributes are mutually exclusive. Exactly one of these attributes MUST be specified on all controls.

tag: An ST_String attribute, as specified in section 2.4.19, that specifies an arbitrary string that provides additional information about this control during callback function calls. If this attribute is omitted, the value defaults to an empty string.

idMso: An ST_ID attribute, as specified in section 2.4.12, that specifies the identifier of a built-in control. The id, idQ, and idMso attributes are mutually exclusive. Exactly one of these attributes MUST be specified.

screentip: An ST_String attribute, as specified in section 2.4.19, that specifies a string that is displayed as the tooltip for this control. The screentip and getScreentip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a tooltip is not displayed.

getScreentip: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the tooltip of this control. The screentip and getScreentip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a tooltip is not displayed.

supertip: An ST_String attribute that specifies a string that is displayed as the Enhanced ScreenTip of this control. The supertip and getSupertip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, an Enhanced ScreenTip is not displayed.

getSupertip: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the Enhanced ScreenTip of this control. The supertip and getSupertip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, an Enhanced ScreenTip is not displayed.

label: An ST_String attribute that specifies a string that is displayed as the label of this control. The label and getLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a label is not displayed.

getLabel: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the label of this control. The label and getLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a label is not displayed.

insertAfterMso: An ST_ID attribute that specifies the identifier of a built-in control after which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

insertBeforeMso: An ST_ID attribute that specifies the identifier of a built-in control before which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

insertAfterQ: An ST_QID attribute, as specified in section 2.4.17, that specifies the qualified identifier of a control after which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

insertBeforeQ: An ST_QID attribute that specifies the qualified identifier of a control before which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

visible: A Boolean attribute that specifies the visibility state of this control. The visible and getVisible attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to being visible.

getVisible: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the visibility state of this control. The visible and getVisible attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to being visible.

keytip: An ST_Keytip attribute, as specified in section 2.4.14, that specifies a string that is displayed as the KeyTip for this control. The keytip and getKeytip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a KeyTip is not displayed.

getKeytip: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the KeyTip for this control. The keytip and getKeytip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a KeyTip is not displayed.

showLabel: A Boolean attribute that specifies whether the label for this control will be displayed. The showLabel and getShowLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the label of the control will be displayed.

getShowLabel: An ST_Delegate attribute that specifies the name of a callback function that is called to determine whether to display the label of this control. The showLabel and getShowLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the label of the control will be displayed.

showImage: A Boolean attribute that specifies whether the icon for this control will be displayed. The showImage and getShowImage attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the icon of the control will be displayed.

getShowImage: An ST_Delegate attribute that specifies the name of a callback function that is called to determine whether to display the icon of this control. The showImage and getShowImage attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the icon of the control will be displayed.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_Button">

<xsd:complexContent>

<xsd:extension base="CT_ButtonRegular">

<xsd:attributeGroup ref="AG_SizeAttributes"/>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Constructors

Button()

Initializes a new instance of the Button class.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Description	description, this property is only available in Office 2010 and later. Represents the following attribute in the schema: description
Enabled	enabled, this property is only available in Office 2010 and later. Represents the following attribute in the schema: enabled
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
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)
FirstChild	Gets the first child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
GetDescription	getDescription, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getDescription
GetEnabled	getEnabled, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getEnabled
GetImage	getImage, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getImage
GetKeytip	getKeytip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getKeytip
GetLabel	getLabel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getLabel
GetScreentip	getScreentip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getScreentip
GetShowImage	getShowImage, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getShowImage
GetShowLabel	getShowLabel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getShowLabel
GetSize	getSize, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getSize
GetSupertip	getSupertip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getSupertip
GetVisible	getVisible, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getVisible
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 OpenXmlLeafElement)
Id	id, this property is only available in Office 2010 and later. Represents the following attribute in the schema: id
IdMso	idMso, this property is only available in Office 2010 and later. Represents the following attribute in the schema: idMso
Image	image, this property is only available in Office 2010 and later. Represents the following attribute in the schema: image
ImageMso	imageMso, this property is only available in Office 2010 and later. Represents the following attribute in the schema: imageMso
InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement)
InnerXml	Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement)
InsertAfterMso	insertAfterMso, this property is only available in Office 2010 and later. Represents the following attribute in the schema: insertAfterMso
InsertAfterQulifiedId	insertAfterQ, this property is only available in Office 2010 and later. Represents the following attribute in the schema: insertAfterQ
InsertBeforeMso	insertBeforeMso, this property is only available in Office 2010 and later. Represents the following attribute in the schema: insertBeforeMso
InsertBeforeQulifiedId	insertBeforeQ, this property is only available in Office 2010 and later. Represents the following attribute in the schema: insertBeforeQ
Keytip	keytip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: keytip
Label	label, this property is only available in Office 2010 and later. Represents the following attribute in the schema: label
LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
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)
OnAction	onAction, this property is only available in Office 2010 and later. Represents the following attribute in the schema: onAction
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
QualifiedId	idQ, this property is only available in Office 2010 and later. Represents the following attribute in the schema: idQ
Screentip	screentip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: screentip
ShowImage	showImage, this property is only available in Office 2010 and later. Represents the following attribute in the schema: showImage
ShowLabel	showLabel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: showLabel
Size	size, this property is only available in Office 2010 and later. Represents the following attribute in the schema: size
Supertip	supertip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: supertip
Tag	tag, this property is only available in Office 2010 and later. Represents the following attribute in the schema: tag
Visible	visible, this property is only available in Office 2010 and later. Represents the following attribute in the schema: visible
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)
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 OpenXmlElement)
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 OpenXmlElement)
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 in the current element's list of child elements. (Inherited from OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement)
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)
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 elements. (Inherited from OpenXmlElement)
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)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all child elements of the current element. (Inherited from OpenXmlLeafElement)
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 from the current element's list of child elements. (Inherited from OpenXmlElement)
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 a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement)
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 OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)