RibbonButton.Image Property

Definition

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

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

public:
 property System::Drawing::Image ^ Image { System::Drawing::Image ^ get(); void set(System::Drawing::Image ^ value); };

public System.Drawing.Image Image { get; set; }

member this.Image : System.Drawing.Image with get, set

Public Property Image As Image

Property Value

Image

An Image that is displayed on the button.

Examples

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;
}

Private Sub LoadImages()
    button1.ShowImage = True
    Button2.ShowImage = True
    Button1.Image = My.Resources.Image1
    Button2.Image = My.Resources.Image2
End Sub

Remarks

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.