ToolStripItemRenderEventArgs Class
.NET Framework 4
Provides data for the events that render the background of objects derived from ToolStripItem in the ToolStripRenderer class.
System.Object
System.EventArgs
System.Windows.Forms.ToolStripItemRenderEventArgs
System.Windows.Forms.ToolStripItemImageRenderEventArgs
System.Windows.Forms.ToolStripItemTextRenderEventArgs
System.Windows.Forms.ToolStripSeparatorRenderEventArgs
System.EventArgs
System.Windows.Forms.ToolStripItemRenderEventArgs
System.Windows.Forms.ToolStripItemImageRenderEventArgs
System.Windows.Forms.ToolStripItemTextRenderEventArgs
System.Windows.Forms.ToolStripSeparatorRenderEventArgs
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The ToolStripItemRenderEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ToolStripItemRenderEventArgs | Initializes a new instance of the ToolStripItemRenderEventArgs class for the specified ToolStripItem and using the specified Graphics. |
| Name | Description | |
|---|---|---|
![]() | Graphics | Gets the graphics used to paint the ToolStripItem. |
![]() | Item | Gets the ToolStripItem to paint. |
![]() | ToolStrip | Gets the value of the ToolStripItem.Owner property for the ToolStripItem to paint. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
The following code example demonstrates how to override the OnRenderButtonBackground method to draw a border around a ToolStripButton control's Image. This code example is part of a larger example provided for the ToolStripRenderer class.
// This method draws a border around the button's image. If the background // to be rendered belongs to the empty cell, a string is drawn. Otherwise, // a border is drawn at the edges of the button. protected override void OnRenderButtonBackground( ToolStripItemRenderEventArgs e) { base.OnRenderButtonBackground(e); // Define some local variables for convenience. Graphics g = e.Graphics; GridStrip gs = e.ToolStrip as GridStrip; ToolStripButton gsb = e.Item as ToolStripButton; // Calculate the rectangle around which the border is painted. Rectangle imageRectangle = new Rectangle( borderThickness, borderThickness, e.Item.Width - 2 * borderThickness, e.Item.Height - 2 * borderThickness); // If rendering the empty cell background, draw an // explanatory string, centered in the ToolStripButton. if (gsb == gs.EmptyCell) { e.Graphics.DrawString( "Drag to here", gsb.Font, SystemBrushes.ControlDarkDark, imageRectangle, style); } else { // If the button can be a drag source, paint its border red. // otherwise, paint its border a dark color. Brush b = gs.IsValidDragSource(gsb) ? b = Brushes.Red : SystemBrushes.ControlDarkDark; // Draw the top segment of the border. Rectangle borderSegment = new Rectangle( 0, 0, e.Item.Width, imageRectangle.Top); g.FillRectangle(b, borderSegment); // Draw the right segment. borderSegment = new Rectangle( imageRectangle.Right, 0, e.Item.Bounds.Right - imageRectangle.Right, imageRectangle.Bottom); g.FillRectangle(b, borderSegment); // Draw the left segment. borderSegment = new Rectangle( 0, 0, imageRectangle.Left, e.Item.Height); g.FillRectangle(b, borderSegment); // Draw the bottom segment. borderSegment = new Rectangle( 0, imageRectangle.Bottom, e.Item.Width, e.Item.Bounds.Bottom - imageRectangle.Bottom); g.FillRectangle(b, borderSegment); } }
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.
