Export (0) Print
Expand All
Expand Minimize

ToolStripRenderer.OnRenderToolStripBackground Method

Raises the RenderToolStripBackground event.

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

protected virtual void OnRenderToolStripBackground(
	ToolStripRenderEventArgs e
)

Parameters

e
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 override void OnRenderToolStripBackground(
    ToolStripRenderEventArgs e)
{
    base.OnRenderToolStripBackground(e);

    // 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 (this.backgroundBrush == null)
    {
        this.backgroundBrush = new LinearGradientBrush(
           e.ToolStrip.ClientRectangle,
           SystemColors.ControlLightLight,
           SystemColors.ControlDark,
           90,
           true);
    }

    // Paint the GridStrip control's background.
    e.Graphics.FillRectangle(
        this.backgroundBrush, 
        e.AffectedBounds);
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft