RibbonButton.Image Property

 

Gets or sets the image that is displayed on the button.

Namespace:   Microsoft.Office.Tools.Ribbon
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Image Image { get; set; }

Property Value

Type: System.Drawing.Image

An Image that is displayed on the button.

The recommended image format is PNG, because images in the PNG format support transparency through their alpha channel.

The Image property identifies an image that is displayed by the control. This property can be set at design time or at run time. If you update this property at run time, the control's appearance is updated to reflect the change.

If the Image property is set, the OfficeImageId and ImageName properties are ignored. Although the Image property gives you more control than the other two properties do, it can be slower because the image object is sent to the Office application every time the control is updated.

The ShowImage property must be true for the control to display the image. When you set the Image property at design time, Visual Studio automatically sets the ShowImage property to true. If you set the Image property at run time, you must set the ShowImage property to true in your code.

The following example sets the Image property of two buttons. To run this code example, you must first perform the following steps:

  1. Add a Ribbon (Visual Designer) item to a project created by using Office development tools in Visual Studio.

  2. Add a group to the custom tab.

  3. Add two buttons to the group.

  4. Add two images to the project resources.

private void LoadImages()
{
    button1.ShowImage = true;
    button2.ShowImage = true;
    button1.Image = Properties.Resources.Image1;
    button2.Image = Properties.Resources.Image2;
}
Return to top
Show: