ToolStripRenderer.OnRenderToolStripBorder Method (System.Windows.Forms)

OnRenderToolStripBorder Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

ToolStripRenderer.OnRenderToolStripBorder Method

Note: This method is new in the .NET Framework version 2.0.

Raises the RenderToolStripBorder event.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

Syntax

Visual Basic (Declaration)

Protected Overridable Sub OnRenderToolStripBorder ( _
    e As ToolStripRenderEventArgs _
)

Visual Basic (Usage)

Dim e As ToolStripRenderEventArgs

Me.OnRenderToolStripBorder(e)

protected virtual void OnRenderToolStripBorder (
    ToolStripRenderEventArgs e
)

C++

protected:
virtual void OnRenderToolStripBorder (
    ToolStripRenderEventArgs^ e
)

protected void OnRenderToolStripBorder (
    ToolStripRenderEventArgs e
)

JScript

protected function OnRenderToolStripBorder (
    e : ToolStripRenderEventArgs
)

Parameters

e: A ToolStripRenderEventArgs that contains the event data.

Remarks

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnRenderToolStripBorder 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 OnRenderToolStripBorder in a derived class, be sure to call the base class's OnRenderToolStripBorder method so that registered delegates receive the event.

Example

The following code example demonstrates how to override the OnRenderToolStripBorder method to draw a custom border around a ToolStrip control. This code example is part of a larger example provided for the ToolStripRenderer class.

Visual Basic

' This method draws a border around the GridStrip control.
Protected Overrides Sub OnRenderToolStripBorder(e As ToolStripRenderEventArgs)
   MyBase.OnRenderToolStripBorder(e)
   
   ControlPaint.DrawFocusRectangle(e.Graphics, e.AffectedBounds, SystemColors.ControlDarkDark, SystemColors.ControlDarkDark)
End Sub

// This method draws a border around the GridStrip control.
protected override void OnRenderToolStripBorder(
    ToolStripRenderEventArgs e)
{
    base.OnRenderToolStripBorder(e);

    ControlPaint.DrawFocusRectangle(
        e.Graphics,
        e.AffectedBounds,
        SystemColors.ControlDarkDark,
        SystemColors.ControlDarkDark);
}

Platforms

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0

Reference

ToolStripRenderer Class
ToolStripRenderer Members
System.Windows.Forms Namespace

Other Resources

How to: Implement a Custom ToolStripRenderer