Difference between revisions of "RxBox"
From Ribbon Commander Documentation
| Line 8: | Line 8: | ||
== Properties == | == Properties == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=boxStyle}} | ||
| + | {{DocTableEntry | name=id}} | ||
| + | {{DocTableEntry | name=idQ}} | ||
| + | {{DocTableEntry | name=insertAfterMso}} | ||
| + | {{DocTableEntry | name=insertAfterQ}} | ||
| + | {{DocTableEntry | name=insertBeforeMso}} | ||
| + | {{DocTableEntry | name=insertBeforeQ}} | ||
| + | {{DocTableEntry | name=isEmpty}} | ||
| + | {{DocTableEntry | name=isLive}} | ||
| + | {{DocTableEntry | name=parent}} | ||
| + | {{DocTableEntry | name=visible}} | ||
| + | {{DocTableEntry | name=xml}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == Collections == | ||
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
{{DocTableEntry | name=boxes_rxBox}} | {{DocTableEntry | name=boxes_rxBox}} | ||
| − | |||
{{DocTableEntry | name=buttonGroups_rxBox}} | {{DocTableEntry | name=buttonGroups_rxBox}} | ||
{{DocTableEntry | name=buttons_rxBox}} | {{DocTableEntry | name=buttons_rxBox}} | ||
| Line 20: | Line 35: | ||
{{DocTableEntry | name=editBoxes_rxBox}} | {{DocTableEntry | name=editBoxes_rxBox}} | ||
{{DocTableEntry | name=galleries_rxBox}} | {{DocTableEntry | name=galleries_rxBox}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{DocTableEntry | name=labelControls_rxBox}} | {{DocTableEntry | name=labelControls_rxBox}} | ||
{{DocTableEntry | name=menus_rxBox}} | {{DocTableEntry | name=menus_rxBox}} | ||
| − | |||
| − | |||
| − | |||
{{DocTableEntry | name=ribbonXControls}} | {{DocTableEntry | name=ribbonXControls}} | ||
{{DocTableEntry | name=splitButtons_rxBox}} | {{DocTableEntry | name=splitButtons_rxBox}} | ||
{{DocTableEntry | name=toggleButtons_rxBox}} | {{DocTableEntry | name=toggleButtons_rxBox}} | ||
| + | {{DocTableEnd}} | ||
| − | |||
| − | |||
| − | |||
== Methods == | == Methods == | ||
Revision as of 16:10, 12 March 2013
Contents
Description
rxBox models element CT_Box of the MS Custom UI XML specification which specifies a grouping container control that aligns child controls horizontally or vertically.
Properties
Property Name
|
Description
|
| boxStyle | Specifies the alignment direction of the child controls |
| id | The ID of a custom UI element. IDs must be unique |
| idQ | A qualified control ID. Qualified IDs allow different add-ins to modify the same custom group, tab, or menu |
| 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 |
| isEmpty | Read-only property; returns true if the control is empty |
| isLive | Read-only property; returns true if the control is live |
| parent | The control's parent object |
| visible | Whether the control is visible |
| xml | Returns the xml node that corresponds to the state of the control |
Collections
Property Name
|
Description
|
| boxes | A collection of boxes |
| buttonGroups | A collection of button groups |
| buttons | A collection of buttons |
| checkBoxes | A collection of check boxes |
| comboBoxes | A collection of combo boxes |
| controls | A collection of controls that can enable, disable or clone built-in controls |
| dropDowns | A collection of drop-downs |
| dynamicMenus | A collection of dynamic menus |
| editBoxes | A collection of edit boxes |
| galleries | A collection of galleries |
| labelControls | A collection of label controls |
| menus | A collection of menus |
| ribbonXControls | The collection of all contained ribbonX controls |
| splitButtons | A collection of split-buttons |
| toggleButtons | A collection of toggle-buttons |
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
|
| getVisible | Callback that sets the control's visible state |
Events
Event Name
|
Description
|
| OnGetVisible | Callback that sets the control's visible state |
