HelpEventArgs.Create

Syntax

Create(ContextId: Variant; Handled: Boolean);

Parameters

ContextId. Identifier of the help section that is set for the component.

Handled. Indicates whether the help system handles the process.

Description

The IHelpEventArgs constructor creates an argument of the event that occurs when pressing the component, if the mode of help displaying is active or on pressing the F1 button for the active component.

Example

Executing the example requires a form and a button named Button1 on the form. Handling of the OnHelp event is set for the form.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    Argument: IHelpEventArgs;
Begin
    Argument := New HelpEventArgs.Create(100, True);
    Self.OnHelp(Self, Argument)
End Sub Button1OnClick;

After executing the example the events of help receive for the component that has 100 identifier of the help section is generated.