Control.OnHelpRequested Method (System.Windows.Forms)

OnHelpRequested Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Control..::.OnHelpRequested Method

Raises the HelpRequested event.

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

Syntax

Visual Basic

Protected Overridable Sub OnHelpRequested ( _
    hevent As HelpEventArgs _
)

protected virtual void OnHelpRequested(
    HelpEventArgs hevent
)

Visual C++

protected:
virtual void OnHelpRequested(
    HelpEventArgs^ hevent
)

abstract OnHelpRequested : 
        hevent:HelpEventArgs -> unit 
override OnHelpRequested : 
        hevent:HelpEventArgs -> unit

Parameters

hevent: Type: System.Windows.Forms..::.HelpEventArgs
A HelpEventArgs that contains the event data.

Remarks

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

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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

Control Class

System.Windows.Forms Namespace

HelpRequested