GalleryRegular Class
Defines the GalleryRegular Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is mso14:gallery.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Office2010.CustomUI.GalleryRegular
Namespace: DocumentFormat.OpenXml.Office2010.CustomUI
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Item), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ButtonRegular), FileFormatVersions.Office2010)> _
Public Class GalleryRegular _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As GalleryRegular
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Item), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ButtonRegular), FileFormatVersions.Office2010)]
public class GalleryRegular : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
Item <mso14:item>
ButtonRegular <mso14:button>
2.3.19 CT_GalleryRegular
Target namespace: https://schemas.microsoft.com/office/2007/10/customui
Referenced by: CT_Gallery, CT_MenuRegular, CT_MenuWithTitle, CT_Menu, CT_ButtonGroup, CT_ContextMenu
Specifies a gallery(2) control, which is of fixed size because of its location. It is otherwise identical to the CT_Gallery complex type.
Child Elements:
item : A CT_Item element.
button : A CT_ButtonRegular element.
Attributes:
description : An ST_LongString attribute that specifies a string which 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 which 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.
invalidateContentOnDrop : A boolean attribute that specifies whether this control invalidates its contents and re-queries for them each time the user opens its drop-down menu.
columns : An ST_GalleryRowColumnCount attribute that specifies the number of columns displayed in this gallery(2) control. If this attribute is omitted, the number of columns is chosen automatically based on the total number of items.
rows : An ST_GalleryRowColumnCount attribute that specifies the number of rows displayed in this gallery(2) control. If this attribute is omitted, the number of rows is chosen automatically based on the total number of items.
itemWidth : An ST_GalleryItemWidthHeight attribute that specifies the width, in pixels, of the selection items in this control. The itemWidth and getItemWidth attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the size of the first item’s contents determines the width of all the items in the control.
itemHeight : An ST_GalleryItemWidthHeight attribute that specifies the height, in pixels, of the selection items in this control. The itemHeight and getItemHeight attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the items will all take the height of the first item, based on its contents.
getItemWidth : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the width, in pixels, of the selection items in this control. The itemWidth and getItemWidth attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the items will all take the width of the first item, based on its contents.
getItemHeight : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the height, in pixels, of the selection items in this control. The itemHeight and getItemHeight attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the items will all take the height of the first item, based on its contents.
showItemLabel : A boolean attribute that specifies whether the selection items in this control display labels. If this attribute is omitted, the selection items display labels.
onAction : An ST_Delegate attribute that specifies the name of a callback function which 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 which 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.
image : An ST_Uri attribute that specifies the relationship identifier of an image file which 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, then an icon is not displayed.
imageMso : An ST_ID attribute that specifies the identifier of a built-in image which 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, then an icon is not displayed.
getImage : An ST_Delegate attribute that specifies the name of a callback function which 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, then an icon is not displayed.
showItemImage : A boolean attribute that specifies whether this control displays icons on its selection items.
getItemCount : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the number of dynamically created selection items in this control. If this attribute is omitted then the control displays the selection items which are specified as child elements. If this attribute is omitted and no child items are specified then the control is empty. If both this attribute and child items are specified then the child items are ignored.
getItemLabel : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the labels of dynamically created selection items in this control. If this attribute is omitted, dynamically created selection items do not display labels.
getItemScreentip : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the tooltips of dynamically created selection items in this control. If this attribute is omitted, dynamically created selection items do not display tooltips.
getItemSupertip : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the Enhanced ScreenTips of dynamically created selection items in this control. If this attribute is omitted, dynamically created selection items do not display Enhanced ScreenTips.
getItemImage : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the icons of dynamically created selection items in this control. If this attribute is omitted, dynamically created selection items do not display icons.
getItemID : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the IDs of dynamically created selection items in this control. If this attribute is omitted, dynamically created selection items have empty IDs.
sizeString : An ST_String attribute that specifies a string whose size is used to determine the width of the text input area of this control. If this attribute is omitted, the application will determine the width of the text input area automatically.
getSelectedItemID : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the identifier of the item which is selected in this control. The getSelectedItemID and getSelectedItemIndex attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes is specified, the control will not display a selected item.
getSelectedItemIndex : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the index of the item which is selected in this control. The getSelectedItemID and getSelectedItemIndex attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes is specified, the control will not display a selected item.
id : An ST_UniqueID attribute that specifies the identifier of a custom control. All custom controls MUST have unique IDs. 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 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.
idMso : An ST_ID attribute 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.
tag : An ST_String attribute that specifies an arbitrary string which provides additional information about this control during callback function calls. If this attribute is omitted, the value defaults to an empty string.
screentip : An ST_String attribute that specifies a string which 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 then a tooltip is not displayed.
getScreentip : An ST_Delegate attribute that specifies the name of a callback function which 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 then a tooltip is not displayed.
supertip : An ST_String attribute that specifies a string which 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 then a Enhanced ScreenTip is not displayed.
getSupertip : An ST_Delegate attribute that specifies the name of a callback function which 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 then an Enhanced ScreenTip is not displayed.
label : An ST_String attribute that specifies a string which 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, then a label is not displayed.
getLabel : An ST_Delegate attribute that specifies the name of a callback function which 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, then a label is not displayed.
insertAfterMso : An ST_ID attribute that specifies the identifier of a built-in control which this control will be inserted after. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 which this control will be inserted before. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 that specifies the qualified identifier of a control which this control will be inserted after. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 which this control will be inserted before. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 of these attributes are specified, then the control defaults to being visible.
getVisible : An ST_Delegate attribute that specifies the name of a callback function which 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 of these attributes are specified, the control defaults to being visible.
keytip : An ST_Keytip attribute that specifies a string which is displayed as the KeyTip for this control. The keytip and getKeytip attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes are specified, a KeyTip is not displayed.
getKeytip : An ST_Delegate attribute that specifies the name of a callback function which 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 of these attributes are 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 of these attributes are specified, the label of the control will be displayed.
getShowLabel : An ST_Delegate attribute that specifies the name of a callback function which 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 of these attributes are 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 of these attributes are specified, the icon of the control will be displayed.
getShowImage : An ST_Delegate attribute that specifies the name of a callback function which 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 of these attributes are 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_GalleryRegular">
<xsd:complexContent>
<xsd:extension base="CT_DropDownRegular">
<xsd:attributeGroup ref="AG_Description"/>
<xsd:attributeGroup ref="AG_DynamicContentAttributes"/>
<xsd:attribute name="columns" type="ST_GalleryRowColumnCount" use="optional"/>
<xsd:attribute name="rows" type="ST_GalleryRowColumnCount" use="optional"/>
<xsd:attribute name="itemWidth" type="ST_GalleryItemWidthHeight" use="optional"/>
<xsd:attribute name="itemHeight" type="ST_GalleryItemWidthHeight" use="optional"/>
<xsd:attribute name="getItemWidth" type="ST_Delegate" use="optional"/>
<xsd:attribute name="getItemHeight" type="ST_Delegate" use="optional"/>
<xsd:attribute name="showItemLabel" type="xsd:boolean" use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
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.