HelpEventArgs Class

 

Provides data for the HelpRequested event.

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

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

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

NameDescription
System_CAPS_pubmethodHelpEventArgs(Point)

Initializes a new instance of the HelpEventArgs class.

NameDescription
System_CAPS_pubpropertyHandled

Gets or sets a value indicating whether the help event was handled.

System_CAPS_pubpropertyMousePos

Gets the screen coordinates of the mouse pointer.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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 Handling and Raising Events.

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
Available since 1.1

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

Return to top
Show: