OfficeRibbon::LoadImage Event

 

Occurs when the OfficeRibbon loads, if the ImageName property is set for one or more controls.

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

C#
C++
F#
VB
Copy 
event RibbonLoadImageEventHandler^ LoadImage {
	void add(RibbonLoadImageEventHandler^ value);
	void remove(RibbonLoadImageEventHandler^ value);
}

The LoadImage event enables you to cache images in the Ribbon customization, which can improve performance.

By default, an image is loaded into the Ribbon every time the user displays a tab that contains the image. An image is reloaded any time that you programmatically change the properties of a control on which the image appears.

Use the LoadImage event to assign an image to a control. When the user selects a tab on the Ribbon, the Microsoft Office application uses the cached image. If you modify a control property at run time, the Microsoft Office application will not reload the image on the control. This can give you a small performance gain.

If you want to cache the image of a control, set the ImageName property of the control. The LoadImage event is not raised unless you set the ImageName property of at least one control.

Return to top
Show: