OnRenderToolStripBackground Method

ToolStripRenderer.OnRenderToolStripBackground Method (ToolStripRenderEventArgs)


Raises the RenderToolStripBackground event.

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

Protected Overridable Sub OnRenderToolStripBackground (
	e As ToolStripRenderEventArgs


Type: System.Windows.Forms.ToolStripRenderEventArgs

A ToolStripRenderEventArgs that contains the event data.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnRenderToolStripBackground method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:

When overriding OnRenderToolStripBackground in a derived class, be sure to call the base class's OnRenderToolStripBackground method so that registered delegates receive the event.

The following code example demonstrates how to override the OnRenderToolStripBackground method to paint a gradient in the background of a ToolStrip control. This code example is part of a larger example provided for the ToolStripRenderer class.

' This method renders the GridStrip control's background.
Protected Overrides Sub OnRenderToolStripBackground(e As ToolStripRenderEventArgs)

   ' This late initialization is a workaround. The gradient
   ' depends on the bounds of the GridStrip control. The bounds 
   ' are dependent on the layout engine, which hasn't fully
   ' performed layout by the time the Initialize method runs.
   If Me.backgroundBrush Is Nothing Then
      Me.backgroundBrush = New LinearGradientBrush(e.ToolStrip.ClientRectangle, SystemColors.ControlLightLight, SystemColors.ControlDark, 90, True)
   End If

   ' Paint the GridStrip control's background.
   e.Graphics.FillRectangle(Me.backgroundBrush, e.AffectedBounds)
  End Sub

.NET Framework
Available since 2.0
Return to top
© 2016 Microsoft