Difference between revisions of "RxDropDownRegular"
From Ribbon Commander Documentation
Line 19: | Line 19: | ||
{{DocTableEntry | name=insertBeforeMso}} | {{DocTableEntry | name=insertBeforeMso}} | ||
{{DocTableEntry | name=insertBeforeQ}} | {{DocTableEntry | name=insertBeforeQ}} | ||
− | |||
{{DocTableEntry | name=isEmpty}} | {{DocTableEntry | name=isEmpty}} | ||
{{DocTableEntry | name=isLive}} | {{DocTableEntry | name=isLive}} | ||
{{DocTableEntry | name=keytip}} | {{DocTableEntry | name=keytip}} | ||
{{DocTableEntry | name=label}} | {{DocTableEntry | name=label}} | ||
− | |||
{{DocTableEntry | name=parent}} | {{DocTableEntry | name=parent}} | ||
{{DocTableEntry | name=screentip}} | {{DocTableEntry | name=screentip}} | ||
{{DocTableEntry | name=showImage}} | {{DocTableEntry | name=showImage}} | ||
+ | {{DocTableEntry | name=showItemImage}} | ||
+ | {{DocTableEntry | name=showItemLabel}} | ||
{{DocTableEntry | name=showLabel}} | {{DocTableEntry | name=showLabel}} | ||
{{DocTableEntry | name=sizeString}} | {{DocTableEntry | name=sizeString}} | ||
Line 38: | Line 38: | ||
== {{Collections Section Title}} == | == {{Collections Section Title}} == | ||
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxDropDownRegular | propName=buttons}} |
+ | {{DocTableColEntry | controlName=rxDropDownRegular | propName=items}} | ||
{{DocTableEntry | name=ribbonXControls}} | {{DocTableEntry | name=ribbonXControls}} | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
Line 51: | Line 52: | ||
== Delegates == | == Delegates == | ||
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}} | ||
− | |||
{{DocTableEntry | name=getEnabled}} | {{DocTableEntry | name=getEnabled}} | ||
{{DocTableEntry | name=getImage}} | {{DocTableEntry | name=getImage}} | ||
Line 57: | Line 57: | ||
{{DocTableEntry | name=getLabel}} | {{DocTableEntry | name=getLabel}} | ||
{{DocTableEntry | name=getScreentip}} | {{DocTableEntry | name=getScreentip}} | ||
+ | {{DocTableEntry | name=getSelectedItemIndex}} | ||
{{DocTableEntry | name=getShowImage}} | {{DocTableEntry | name=getShowImage}} | ||
{{DocTableEntry | name=getShowLabel}} | {{DocTableEntry | name=getShowLabel}} | ||
{{DocTableEntry | name=getSupertip}} | {{DocTableEntry | name=getSupertip}} | ||
− | |||
{{DocTableEntry | name=getVisible}} | {{DocTableEntry | name=getVisible}} | ||
+ | {{DocTableEntry | name=onChange_dropdown}} | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
== Events == | == Events == | ||
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | ||
− | {{DocTableEntry | name= | + | {{DocTableEntry | name=OnActionEvent_dropdown}} |
{{DocTableEntry | name=OnGetEnabled}} | {{DocTableEntry | name=OnGetEnabled}} | ||
{{DocTableEntry | name=OnGetImage}} | {{DocTableEntry | name=OnGetImage}} | ||
Line 72: | Line 73: | ||
{{DocTableEntry | name=OnGetLabel}} | {{DocTableEntry | name=OnGetLabel}} | ||
{{DocTableEntry | name=OnGetScreentip}} | {{DocTableEntry | name=OnGetScreentip}} | ||
+ | {{DocTableEntry | name=OnGetSelectedItemIndex}} | ||
{{DocTableEntry | name=OnGetShowImage}} | {{DocTableEntry | name=OnGetShowImage}} | ||
{{DocTableEntry | name=OnGetShowLabel}} | {{DocTableEntry | name=OnGetShowLabel}} | ||
{{DocTableEntry | name=OnGetSupertip}} | {{DocTableEntry | name=OnGetSupertip}} | ||
− | |||
{{DocTableEntry | name=OnGetVisible}} | {{DocTableEntry | name=OnGetVisible}} | ||
{{DocTableEnd}} | {{DocTableEnd}} |
Revision as of 17:44, 12 March 2013
Contents
Description
rxDropDownRegular models element CT_DropDownRegular of the MS Custom UI XML specification which specifies a standard drop-down control which optionally has a group of buttons below its selection items.
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 |
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 |
parent | The control's parent object |
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 |
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
|
getEnabled | Callback that sets the control's enabled state |
getImage | Callback for a custom image |
getKeytip | Callback that sets the keytip |
getLabel | Callback that sets the label |
getScreentip | Callback that sets the screentip |
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 |
getSupertip | Callback that sets the supertip, a large screentip |
getVisible | Callback that sets the control's visible state |
Template:Name onChange dropdown | Template:Desc onChange dropdown |
Events
Event Name
|
Description
|
OnActionEvent | Callback fired on user action |
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 |
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 |
OnGetSupertip | Callback that sets the supertip, a large screentip |
OnGetVisible | Callback that sets the control's visible state |