button

In the object model this is RibbonButton.
Is a single clickable item which could have an image and/or caption
Can be added to a group, button group, drop-down list, gallery, menu or split button.

<tabs>

<button id="button1"

label="Large Button"

imageMso="HappyFace"

size="large"

onAction="Button_OnAction"/>

</group>

</tab>

</tabs>

</ribbon>

</customUI>

Attributes (properties)

description	(Description) Additional text when a large button is added to the Office Menu
enabled	(Enabled) "true" \| "false"
id	(Name) Unique identifier. This is passed as a property on an IRibbonControl object to the callback functions.
idMso	(OfficeImageId) Microsoft built-in command id
idQ	A qualifier identifier, prefixed with a namespace. This allows two different add-ins to add to the same custom group.
image	(Image)
imageMso	(OfficeImageId) Microsoft built-in image id
insertAfterMso
insertAfterQ
insertBeforeMso
insertBeforeQ
keytip	(KeyTip) shortcut key to access the control shown when you press the Alt key
label	(Label) control's caption
screentip	(ScreenTip) appears in bold text when the mouse hovers over
showImage	(ShowImage) "true" \| "false"
showLabel	(ShowLabel) "true" \| "false" if size if large then this is always true
size	(ControlSize) "large" \| "normal" (large is 3 rows) This is not required when inside a SplitButton
supertip	(Added in 2010) (SuperTip) multi-line text appears when the mouse hovers over (1 to 1024 characters). Carriage returns can be entered using [& #13;]
tag	(Tag) 1 to 1024 characters
visible	(Visible) "true" \| "false"
	(GenerateMember)
	(Modifiers) the access modifier assigned Internal
	(ImageName)
	(Locked)
	(Position) Default \| BeforeOfficeId \| AfterOfficeId

C# Events (design-time)

The Button control has a Click event which can be accessed if you use the [[Visual Studio Ribbon Designer]]

' C#

void Button_Click(object sender, RibbonControlEventArgs e)

{

}

this.Button.Click += new Microsoft.Office.Tools.Ribbon.RibbonControlEventHandler(this.Button_Click);

Callbacks (run-time)

onAction	Button_OnAction - This is the run-time equivalent to the design-time Click event
getDescription	Button_OnGetDescription -
getEnabled	Button_OnGetEnabled -
getImage	Button_OnGetImage -
getImageMso	No callback use the following method instead - CommandBars.GetImageMso("officeimagename,16,16)
getKeytip	Button_OnGetKeytip -
getLabel	Button_OnGetLabel -
getScreentip	Button_OnGetScreentip -
getShowImage	Button_OnGetShowImage -
getShowLabel	Button_OnGetShowLabel -
getSize	Button_OnGetSize -
getSupertip	Button_OnGetSupertip -
getVisible	Button_OnGetVisible -

ID vs Tag

It is best practice to use the ID attribute to identify which macro to run when a button is pressed.
However some people use the Tag attribute to hard-code the name of the macro in the Tag attribute.

Using the ID
In the XML, the ID attribute is used to identify the macro.

The callback function uses the ID to identify which macro to run.
Using this approach means you can easily change the name of the macro later on.

Using the Tag
In the XML, the Tag attribute is used with the name of the subroutine.

The callback function calls Application.Run.
Using this approach means you have to update the XML every time you want to change the name of a macro.