This documentation is archived and is not being maintained.

ToolStripItemImageRenderEventArgs Class

Provides data for the RenderItemImage event.


Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public class ToolStripItemImageRenderEventArgs : ToolStripItemRenderEventArgs

The ToolStripItemImageRenderEventArgs type exposes the following members.

Public methodToolStripItemImageRenderEventArgs(Graphics, ToolStripItem, Rectangle)Initializes a new instance of the ToolStripItemImageRenderEventArgs class for the specified ToolStripItem within the specified space and that has the specified properties.
Public methodToolStripItemImageRenderEventArgs(Graphics, ToolStripItem, Image, Rectangle)Initializes a new instance of the ToolStripItemImageRenderEventArgs class for the specified ToolStripItem that displays an image within the specified space and that has the specified properties.

Public propertyGraphicsGets the graphics used to paint the ToolStripItem. (Inherited from ToolStripItemRenderEventArgs.)
Public propertyImageGets the image painted on the ToolStrip.
Public propertyImageRectangleGets the rectangle that represents the bounding area of the image.
Public propertyItemGets the ToolStripItem to paint. (Inherited from ToolStripItemRenderEventArgs.)
Public propertyToolStripGets the value of the ToolStripItem.Owner property for the ToolStripItem to paint. (Inherited from ToolStripItemRenderEventArgs.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the RenderItemImage event. This report helps you to learn when the event occurs and can assist you in debugging.

To run the example code, paste it into a project that contains an instance of a type that inherits from ToolStripRenderer, such as a ToolStripSystemRenderer or ToolStripProfessionalRenderer. Then name the instance ToolStripRenderer1 and ensure that the event handler is associated with the RenderItemImage event.

private void ToolStripRenderer1_RenderItemImage(Object sender, ToolStripItemImageRenderEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "Image", e.Image );
messageBoxCS.AppendFormat("{0} = {1}", "ImageRectangle", e.ImageRectangle );
messageBoxCS.AppendFormat("{0} = {1}", "Graphics", e.Graphics );
messageBoxCS.AppendFormat("{0} = {1}", "Item", e.Item );
messageBoxCS.AppendFormat("{0} = {1}", "ToolStrip", e.ToolStrip );
MessageBox.Show(messageBoxCS.ToString(), "RenderItemImage Event" );

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.