This documentation is archived and is not being maintained.

HelpEventArgs Class

Provides data for the HelpRequested event.

System.Object
  System.EventArgs
    System.Windows.Forms.HelpEventArgs

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

[<ComVisibleAttribute(true)>]
type HelpEventArgs =  
    class
        inherit EventArgs
    end

The HelpEventArgs type exposes the following members.

  NameDescription
Public methodHelpEventArgsInitializes a new instance of the HelpEventArgs class.
Top

  NameDescription
Public propertyHandledGets or sets a value indicating whether the help event was handled.
Public propertyMousePosGets the screen coordinates of the mouse pointer.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The HelpRequested event occurs when the user requests help for a control. A HelpEventArgs object specifies the screen coordinates of the mouse pointer and whether the event was handled.

For information about the event model, see Events and Delegates.

The following example demonstrates handling the HelpRequested event to display custom Help content on a form containing four address fields. The HelpRequested event is raised either by pressing the F1 key with the focus in an address field, or by the using the context-sensitive Help button and clicking the Help cursor on an address field. The Handled property is set to true to indicate that the HelpRequested event is handled. The example also demonstrates storing the Help text in the Control.Tag property.

No code example is currently available or this language may not be supported.

.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

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: