Box 类

定义

命名空间:

DocumentFormat.OpenXml.Office2010.CustomUI

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

定义 Box 类。

此类在 Office 2010 及更高版本中可用。

当对象序列化为 xml 时，其限定名称为 mso14：box。

public class Box : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Box = class
    inherit OpenXmlCompositeElement

Public Class Box
Inherits OpenXmlCompositeElement

继承

Object

OpenXmlElement

OpenXmlCompositeElement

Box

注解

2.3.23 CT_Box

目标命名空间：http://schemas.microsoft.com/office/2009/07/customui

引用者： CT_Box、CT_Group

指定将子控件水平或垂直对齐的分组容器控件。

子元素：

控制：CT_ControlClone 元素，如第 2.3.36 节中所述。

labelControl：CT_LabelControl 元素，如第 2.3.53 节中所述。

按钮：CT_Button 元素，如第 2.3.24 节中所述。

toggleButton：CT_ToggleButton 元素，如第 2.3.81 节中所述。

checkBox：CT_CheckBox 元素，如第 2.3.27 节中所述。

editBox：CT_EditBox 元素，如第 2.3.44 节中所述。

comboBox：CT_ComboBox 元素，如第 2.3.28 节中所述。

dropDown：CT_DropDownRegular 元素，如第 2.3.41 节中所述。

画廊：CT_Gallery 元素，如第 2.3.45 节中所述。

菜单：CT_Menu 元素，如第 2.3.55 节中所述。

dynamicMenu：CT_DynamicMenu 元素，如第 2.3.42 节中所述。

splitButton：CT_SplitButton 元素，如第 2.3.67 节中所述。

箱：CT_Box 元素，如第 2.3.23 节中所述。

buttonGroup：CT_ButtonGroup元素，如第 2.3.25 节中所述。

属性：

id：ST_UniqueID 属性，如第 2.4.22 节中所述，用于指定自定义控件的标识符。 所有自定义控件都必须具有唯一标识符。 id、idQ 和 idMso 属性是互斥的。 必须对所有控件指定其中一个属性。

idQ：ST_QID 属性，如第 2.4.17 节中所述，用于指定控件的限定标识符。 此属性用于引用由其他自定义 UI 文档创建的控件或容器。 id、idQ 和 idMso 属性是互斥的。 必须对所有控件指定其中一个属性。

标记：ST_String 属性，如第 2.4.19 节中所述，该属性指定一个任意字符串，该字符串在回调函数调用期间提供有关此控件的其他信息。 如果省略此属性，则该值默认为空字符串。

可见： 一个 布尔 属性，指定此控件的可见性状态。 visible 和 getVisible 属性是互斥的。 它们不能一起使用。 如果未指定这两个属性，则控件默认为可见。

getVisible：一个 ST_Delegate 属性，该属性指定调用的回调函数的名称，以确定此控件的可见性状态。 visible 和 getVisible 属性是互斥的。 它们不能一起使用。 如果未指定这两个属性，则控件默认为可见。

insertAfterMso：一个 ST_ID 属性，该属性指定将在其后插入此控件的内置控件的标识符。 insertAfterMso、insertAfterQ、insertBeforeMso 和 insertBeforeQ 属性互斥。 它们不能一起使用。 如果未指定这些属性，则将按照在 XML 中定义这些控件的顺序将这些控件追加到现有控件集。

insertBeforeMso：一个 ST_ID 属性，该属性指定将在其之前插入此控件的内置控件的标识符。 insertAfterMso、insertAfterQ、insertBeforeMso 和 insertBeforeQ 属性互斥。 它们不能一起使用。 如果未指定这些属性，则将按照在 XML 中定义这些控件的顺序将这些控件追加到现有控件集。

insertAfterQ：ST_QID 属性，如第 2.4.17 节中所述，该属性指定控件的限定标识符，该控件将在该控件之后插入。 insertAfterMso、insertAfterQ、insertBeforeMso 和 insertBeforeQ 属性互斥。 它们不能一起使用。 如果未指定这些属性，则将按照在 XML 中定义这些控件的顺序将这些控件追加到现有控件集。

insertBeforeQ：一个 ST_QID 属性，该属性指定将在其之前插入此控件的限定标识符。 insertAfterMso、insertAfterQ、insertBeforeMso 和 insertBeforeQ 属性互斥。 它们不能一起使用。 如果未指定这些属性，则将按照在 XML 中定义这些控件的顺序将这些控件追加到现有控件集。

boxStyle：ST_BoxStyle 属性，如第 2.4.3 节中所述，用于指定子控件的对齐方向。 如果省略此属性，则子控件将水平布局。

以下 W3C XML 架构 ([XMLSCHEMA1] 部分 2.1) 片段指定此复杂类型的内容。

<xsd：complexType name=“CT_Box”>

<xsd：group ref=“EG_Controls” minOccurs=“0” maxOccurs=“1000”/>

<xsd：attributeGroup ref=“AG_IDCustom”/>

<xsd：attributeGroup ref=“AG_Visible”/>

<xsd：attributeGroup ref=“AG_PositionAttributes”/>

<xsd：attribute name=“boxStyle” type=“ST_BoxStyle” use=“optional”/>

</xsd：complexType>

有关完整的 W3C XML 架构 ([XMLSCHEMA1] 部分 2.1) ，请参阅第 5.1 节。

构造函数

Box()	初始化 Box 类的新实例。
Box(IEnumerable<OpenXmlElement>)	使用指定的子元素初始化 Box 类的新实例。
Box(OpenXmlElement[])	使用指定的子元素初始化 Box 类的新实例。
Box(String)	从外部 XML 初始化 Box 类的新实例。

属性

BoxStyle	boxStyle，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：boxStyle
ChildElements	获取当前元素的所有子节点。 (继承自 OpenXmlElement)
ExtendedAttributes	获取当前元素的架构) 中未定义的所有扩展属性 (属性。 (继承自 OpenXmlElement)
Features	IFeatureCollection获取当前元素的 。 此功能集合将是只读的，但会从其父部件和包继承功能（如果可用）。 (继承自 OpenXmlElement)
FirstChild	获取当前 OpenXmlElement 元素的第一个子元素。 (继承自 OpenXmlCompositeElement)
GetVisible	getVisible，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：getVisible
HasAttributes	获取一个值，该值指示当前元素是否具有任何属性。 (继承自 OpenXmlElement)
HasChildren	获取一个值，该值指示当前元素是否具有任何子元素。 (继承自 OpenXmlCompositeElement)
Id	id，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：id
InnerText	获取或设置当前节点及其所有子节点的串联值。 (继承自 OpenXmlCompositeElement)
InnerXml	获取或设置仅表示当前节点的子节点的标记。 (继承自 OpenXmlCompositeElement)
InsertAfterMso	insertAfterMso，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：insertAfterMso
InsertAfterQulifiedId	insertAfterQ，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：insertAfterQ
InsertBeforeMso	insertBeforeMso，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：insertBeforeMso
InsertBeforeQulifiedId	insertBeforeQ，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：insertBeforeQ
LastChild	获取当前 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlCompositeElement)
LocalName	获取当前元素的本地名称。 (继承自 OpenXmlElement)
MCAttributes	获取或设置标记兼容性属性。 如果未为当前元素定义标记兼容性属性，则返回 null。 (继承自 OpenXmlElement)
NamespaceDeclarations	获取在当前元素中定义的所有命名空间声明。 如果没有命名空间声明，则返回空枚举器。 (继承自 OpenXmlElement)
NamespaceUri	获取当前元素的命名空间 URI。 (继承自 OpenXmlElement)
OpenXmlElementContext	获取当前元素的 OpenXmlElementContext。 (继承自 OpenXmlElement)
OuterXml	获取表示当前元素及其所有子元素的标记。 (继承自 OpenXmlElement)
Parent	获取当前元素的父元素。 (继承自 OpenXmlElement)
Prefix	获取当前元素的命名空间前缀。 (继承自 OpenXmlElement)
QualifiedId	idQ，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：idQ
Tag	标记，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性： 标记
Visible	可见，此属性仅在 Office 2010 及更高版本中可用。 表示架构中的以下属性：可见
XmlQualifiedName	获取当前元素的限定名称。 (继承自 OpenXmlElement)
XName	获取当前元素的限定名称。 (继承自 OpenXmlElement)

方法

AddAnnotation(Object)	将 对象添加到当前 OpenXmlElement 元素的批注列表中。 (继承自 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	如果指定元素是已知的子元素，则将其添加到 元素。 这会根据架构将 元素添加到正确的位置。 (继承自 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	将命名空间声明添加到当前节点。 (继承自 OpenXmlElement)
Ancestors()	枚举当前元素的所有上级。 (继承自 OpenXmlElement)
Ancestors<T>()	仅枚举具有指定类型的当前元素的上级。 (继承自 OpenXmlElement)
Annotation(Type)	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotation<T>()	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotations(Type)	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Annotations<T>()	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	将元素列表中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
Append(OpenXmlElement[])	将元素数组中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
AppendChild<T>(T)	将指定的元素追加到当前元素的子节点列表的末尾。 (继承自 OpenXmlCompositeElement)
ClearAllAttributes()	清除所有属性，包括已知属性和扩展属性。 (继承自 OpenXmlElement)
Clone()	创建当前节点的副本。 (继承自 OpenXmlElement)
CloneNode(Boolean)	创建此节点的副本。
Descendants()	枚举当前元素的所有后代。 (继承自 OpenXmlElement)
Descendants<T>()	枚举类型为 T 的当前元素的所有后代。 (继承自 OpenXmlElement)
Elements()	枚举当前元素的所有子元素。 (继承自 OpenXmlElement)
Elements<T>()	仅枚举具有指定类型的当前元素的子元素。 (继承自 OpenXmlElement)
ElementsAfter()	枚举与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
ElementsBefore()	枚举当前元素之前且具有与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
GetAttribute(String, String)	获取具有指定标记名称和命名空间 URI 的 Open XML 属性。 (继承自 OpenXmlElement)
GetAttributes()	获取一个列表，该列表包含所有属性的副本。 (继承自 OpenXmlElement)
GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)
GetFirstChild<T>()	查找类型 T 中的第一个子元素。 (继承自 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	在指定的引用元素之后立即插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	在当前元素之后立即插入指定的元素。 (继承自 OpenXmlElement)
InsertAt<T>(T, Int32)	在当前元素的子元素的指定索引处插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	将指定的元素紧接在指定的引用元素之前。 (继承自 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	将指定的元素紧接在当前元素的前面。 (继承自 OpenXmlElement)
IsAfter(OpenXmlElement)	确定当前元素是否以文档顺序显示在指定元素之后。 (继承自 OpenXmlElement)
IsBefore(OpenXmlElement)	确定当前元素是否按文档顺序显示在指定元素之前。 (继承自 OpenXmlElement)
LookupNamespace(String)	解析当前节点上下文中的命名空间前缀。 (继承自 OpenXmlElement)
LookupPrefix(String)	查找当前元素范围内命名空间 URI 的相应前缀。 (继承自 OpenXmlElement)
NextSibling()	获取紧跟在当前 OpenXmlElement 元素后面的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
NextSibling<T>()	获取具有当前 OpenXmlElement 元素后面的指定类型的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
PrependChild<T>(T)	在当前元素的子节点列表的开头插入指定的元素。 (继承自 OpenXmlCompositeElement)
PreviousSibling()	获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic ) 中 Nothing。 (继承自 OpenXmlElement)
PreviousSibling<T>()	获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
Remove()	从其父元素中删除当前元素。 (继承自 OpenXmlElement)
RemoveAllChildren()	删除当前元素的所有子元素。 (继承自 OpenXmlCompositeElement)
RemoveAllChildren<T>()	删除类型为 T 的当前元素的所有子元素。 (继承自 OpenXmlElement)
RemoveAnnotations(Type)	从当前 OpenXmlElement 元素中删除指定类型的注释。 (继承自 OpenXmlElement)
RemoveAnnotations<T>()	从当前 OpenXmlElement 元素中删除具有指定类型的批注。 (继承自 OpenXmlElement)
RemoveAttribute(String, String)	从当前元素中删除 属性。 (继承自 OpenXmlElement)
RemoveChild<T>(T)	删除指定的子元素。 (继承自 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	删除指定前缀的命名空间声明。 如果没有前缀，则不删除任何内容。 (继承自 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	将当前元素的子元素之一替换为另一个 OpenXmlElement 元素。 (继承自 OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	将特性设置为指定的元素。 如果该属性是已知属性，则设置该特性的值。 如果该属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	设置元素的多个属性。 如果属性是已知属性，则会设置该属性的值。 如果属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
WriteTo(XmlWriter)	将当前节点保存到指定的 XmlWriter。 (继承自 OpenXmlElement)

显式接口实现

IEnumerable.GetEnumerator()	定义 Box 类。 此类在 Office 2010 及更高版本中可用。 当对象序列化为 xml 时，其限定名称为 mso14：box。 (继承自 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)