Difference between revisions of "RxGallery"
From Ribbon Commander Documentation
(→Delegates) |
|||
| Line 3: | Line 3: | ||
[[Category:2007 Controls]] | [[Category:2007 Controls]] | ||
| − | [[image: rxGallery.png|right|link=]] | + | [[image: rxGallery.png|310px|right|link=]] |
== Description == | == Description == | ||
rxGallery models element [http://msdn.microsoft.com/en-us/library/dd944655(v=office.12).aspx CT_Gallery] of the MS Custom UI XML specification which specifies a gallery control that displays a drop-down grid of selection items. | rxGallery models element [http://msdn.microsoft.com/en-us/library/dd944655(v=office.12).aspx CT_Gallery] of the MS Custom UI XML specification which specifies a gallery control that displays a drop-down grid of selection items. | ||
Latest revision as of 22:17, 13 March 2013
Contents
Description
rxGallery models element CT_Gallery of the MS Custom UI XML specification which specifies a gallery control that displays a drop-down grid of selection items.
Properties
Property Name
|
Description
|
| columns | Number of columns the control's items are displayed in |
| description | Sets the extended description of the control, which appears in menus with itemSize set to large |
| enabled | Whether the controls is enabled |
| id | The ID of a custom UI element. IDs must be unique |
| idMso | The ID of a built-in control |
| idQ | A qualified control ID. Qualified IDs allow different add-ins to modify the same custom group, tab, or menu |
| image | A custom image or icon |
| imageMso | The image of a built-in control |
| insertAfterMso | The ID of a built-in control to be inserted after |
| insertAfterQ | The ID of a control to be inserted after |
| insertBeforeMso | The ID of a built-in control to be inserted before |
| insertBeforeQ | The ID of control to be inserted before |
| invalidateContentOnDrop | Whether the control invalidates its contents every time the drop-down is opened |
| isEmpty | Read-only property; returns true if the control is empty |
| isLive | Read-only property; returns true if the control is live |
| itemHeight | The height of owned items in pixels |
| itemWidth | The width of owned items in pixels |
| keytip | Sets the control's keytip |
| label | Sets the control's label |
| parent | The control's parent object |
| rows | Number of rows the control's items are displayed in |
| screentip | Sets the screentip, which appears on mouse hover |
| showImage | Whether to show a control's image |
| showItemImage | Whether owned item images are shown |
| showItemLabel | Whether owned item labels are shown |
| showLabel | Whether to show a control's label |
| size | The control's size |
| sizeString | A representative string that sets the control's width |
| supertip | Sets the control's supertip, a large screentip |
| tag | Custom data |
| visible | Whether the control is visible |
| xml | Returns the xml node that corresponds to the state of the control |
Contained Controls
Property Name
|
Description
|
| buttons | A collection of buttons |
| items | The collection of items in the drop-down |
| ribbonXControls | The collection of all contained ribbonX controls |
Methods
Method Name
|
Description
|
| clear | Clears the control's state |
| clone | Creates a clone of the control (a new id is automatically created if applicable) |
| readXml | Populates the control using the passed-in XML string |
Delegates
Delegate Name
|
Description
|
| getDescription | Callback that sets the control's description |
| getEnabled | Callback that sets the control's enabled state |
| getImage | Callback for a custom image |
| getItemCount | Callback for the number of items in a drop-down control |
| getItemHeight | Callback that returns the height of the control's items |
| getItemID | Callback for an item's id |
| getItemImage | Callback for an item's image |
| getItemLabel | Callback for an item's label |
| getItemSupertip | Callback for an item's supertip |
| getItemScreentip | Callback for an item's screentip |
| getItemWidth | Callback that returns the width of the control's items |
| getKeytip | Callback that sets the keytip |
| getLabel | Callback that sets the label |
| getScreentip | Callback that sets the screentip |
| getSelectedItemID | Callback that specifies the ID of the selected item when the control is created/invalidated |
| getSelectedItemIndex | Callback that specifies the index of the selected item when the control is created/invalidated |
| getShowImage | Callback for whether to show the control's image |
| getShowLabel | Callback for whether to show the control's label |
| getSize | Callback for the control's size |
| getSupertip | Callback that sets the supertip, a large screentip |
| getVisible | Callback that sets the control's visible state |
| onAction | Callback fired on user action |
Events
Event Name
|
Description
|
| OnActionEvent | Callback fired on user action |
| OnGetDescription | Callback that sets the control's description |
| OnGetEnabled | Callback that sets the control's enabled state |
| OnGetImage | Callback for a custom image |
| OnGetItemHeight | Callback that returns the height of the control's items |
| OnGetItemWidth | Callback that returns the width of the control's items |
| OnGetKeytip | Callback that sets the keytip |
| OnGetLabel | Callback that sets the label |
| OnGetScreentip | Callback that sets the screentip |
| OnGetSelectedItemIndex | Callback that specifies the index of the selected item when the control is created/invalidated |
| OnGetShowImage | Callback for whether to show the control's image |
| OnGetShowLabel | Callback for whether to show the control's label |
| OnGetSize | Callback for the control's size |
| OnGetSupertip | Callback that sets the supertip, a large screentip |
| OnGetVisible | Callback that sets the control's visible state |
