Difference between revisions of "RxComboBox"
From Ribbon Commander Documentation
(→Collections) |
|||
(One intermediate revision by the same user not shown) | |||
Line 3: | Line 3: | ||
[[Category:2007 Controls]] | [[Category:2007 Controls]] | ||
− | [[image: rxComboBox.png|right|link=]] | + | [[image: rxComboBox.png|310px|right|link=]] |
== Description == | == Description == | ||
rxComboBox models element [http://msdn.microsoft.com/en-us/library/dd926603(v=office.12).aspx CT_ComboBox] of the MS Custom UI XML specification which specifies a standard combo box control. | rxComboBox models element [http://msdn.microsoft.com/en-us/library/dd926603(v=office.12).aspx CT_ComboBox] of the MS Custom UI XML specification which specifies a standard combo box control. | ||
Line 54: | Line 54: | ||
{{DocTableEntry | name=getEnabled}} | {{DocTableEntry | name=getEnabled}} | ||
{{DocTableEntry | name=getImage}} | {{DocTableEntry | name=getImage}} | ||
+ | {{DocTableEntry | name=getItemCount}} | ||
+ | {{DocTableEntry | name=getItemID}} | ||
+ | {{DocTableEntry | name=getItemImage}} | ||
+ | {{DocTableEntry | name=getItemLabel}} | ||
+ | {{DocTableEntry | name=getItemScreentip}} | ||
+ | {{DocTableEntry | name=getItemSupertip}} | ||
{{DocTableEntry | name=getKeytip}} | {{DocTableEntry | name=getKeytip}} | ||
{{DocTableEntry | name=getLabel}} | {{DocTableEntry | name=getLabel}} |
Latest revision as of 17:46, 13 March 2013
Contents
Description
rxComboBox models element CT_ComboBox of the MS Custom UI XML specification which specifies a standard combo box control.
Properties
Property Name
|
Description
|
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 |
keytip | Sets the control's keytip |
label | Sets the control's label |
maxLength | The maximum number of characters the user may enter (must be in range [1,1024]) |
parent | The control's parent object |
screentip | Sets the screentip, which appears on mouse hover |
showImage | Whether to show a control's image |
showLabel | Whether to show a control's label |
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
|
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
|
onChange | Callback that fires when the user changes the control's content |
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 |
getItemID | Callback for an item's id |
getItemImage | Callback for an item's image |
getItemLabel | Callback for an item's label |
getItemScreentip | Callback for an item's screentip |
getItemSupertip | Callback for an item's supertip |
getKeytip | Callback that sets the keytip |
getLabel | Callback that sets the label |
getScreentip | Callback that sets the screentip |
getShowImage | Callback for whether to show the control's image |
getShowLabel | Callback for whether to show the control's label |
getSupertip | Callback that sets the supertip, a large screentip |
getText | Callback that sets the control's initial text |
getVisible | Callback that sets the control's visible state |
Events
Event Name
|
Description
|
OnChangeEvent | Callback that fires when the user changes the control's content |
OnGetEnabled | Callback that sets the control's enabled state |
OnGetImage | Callback for a custom image |
OnGetKeytip | Callback that sets the keytip |
OnGetLabel | Callback that sets the label |
OnGetScreentip | Callback that sets the screentip |
OnGetShowImage | Callback for whether to show the control's image |
OnGetShowLabel | Callback for whether to show the control's label |
OnGetSupertip | Callback that sets the supertip, a large screentip |
OnGetText | Callback that sets the control's initial text |
OnGetVisible | Callback that sets the control's visible state |