HelpEventHandler Delegate

 

Represents the method that will handle the HelpRequested event of a Control.

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

type HelpEventHandler = 
    delegate of 
        sender:Object *
        hlpevent:HelpEventArgs -> unit

Parameters

sender
Type: System.Object

The source of the event.

hlpevent
Type: System.Windows.Forms.HelpEventArgs

A HelpEventArgs that contains the event data.

When you create a HelpEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about handling events with delegates, 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
Return to top
Show: