RibbonButton - harborsiem/WinForms-Ribbon GitHub Wiki
RibbonButton
In the markup file this control is called Button
Public constructors, methods, properties and events:
Constructors:
| Name | Description |
|---|---|
| RibbonButton(RibbonStrip, uint) | Initializes a new instance of the RibbonButton class. |
Methods:
Properties:
| Name | Description |
|---|---|
| CommandId | Get the Id; set by constructor. |
| CommandType | Get the CommandType. Before this control is in view by the UI, the CommandType is Unknown. After this control is first time in UI view the CommandType is Action. |
| Enabled | Get, Set the enabled state. |
| Name | Get, Set an optional Name. |
| Ribbon | Get the RibbonStrip (set by constructor). |
| ResourceIds | Get class MarkupResIds. This class delivers all markup resource ids for a Command. Only available if RibbonStrip.Markupheader is set. |
| Keytip | Get, Set a Keytip string. See Note below. |
| Label | Get, Set a Label (LabelTitle) string. See Note below. |
| LabelDescription | Get, Set a LabelDescription string. (unused) See Note below. |
| TooltipTitle | Get, Set a TooltipTitle string. See Note below. |
| TooltipDescription | Get, Set a TooltipDescription string. See Note below. |
| LargeImage | Get, Set UIImage. See Note below. |
| SmallImage | Get, Set UIImage. See Note below. |
| LargeHighContrastImage | Get, Set UIImage. See Note below. |
| SmallHighContrastImage | Get, Set UIImage. See Note below. |
| Tag | Get, Set an optional Tag. |
Events:
| Name | Description |
|---|---|
| Click | User can handle the click of the button. |
| CreateUICommand | Control is created by the Ribbon Framework |
| DestroyUICommand | Control is destroyed by the Ribbon Framework |
!Note:
For properties Keytip, LableTitle, LabelDescription, TooltipTitle and TooltipDescription: If listed property value is only set by Markup resource you get a value of null (nothing). But if you set RibbonStrip property MarkupHeader to the 'Embedded Resource' RibbonMarkup.h file, you will get the correct string.
!Note:
For properties SmallImage, LargeImage, SmallHighContrastImage and LargeHighContrastImage: If listed property value is only set by Markup resource you get a value of null (nothing).