Syntax

HelpButton x,y,width,height,HelpFileName$,HelpContext, [,.Identifier]

Description

Defines a help button within a dialog template.

Comments

This statement can only appear within a dialog box template (i.e., between the Begin Dialog and End Dialog statements).

The HelpButton statement takes the following parameters:

Parameter

Description

x,y

Integer position of the control (in dialog units) relative to the upper left corner of the dialog box.

width,height

Integer dimensions of the control in dialog units.

HelpFileName$

String expression specifying the name of the help file to be invoked when the button is selected.

HelpContext

Long expression specifying the ID of the topic within HelpFileName$ containing context-sensitive help.

.Identifier

Name by which this control can be referenced by statements in a dialog function (such as DlgFocus and DlgEnable).

When the user selects a help button, the associated help file is located at the indicated topic. Selecting a help button does not remove the dialog. Similarly, no actions are sent to the dialog procedure when a help button is selected.

When a help button is present within a dialog, it can be automatically selected by pressing the help key (F1 on most platforms).

Example

Sub Main()

  Begin Dialog HelpDialogTemplate ,,180,96,"Untitled"

    OKButton 132,8,40,14

    CancelButton 132,28,40,14

    HelpButton 132,48,40,14,"", 10

    Text 16,12,88,12,"Please click ""Help"".",.Text1

  End Dialog

  Dim HelpDialog As HelpDialogTemplate

  Dialog HelpDialog

End Sub

See Also

CancelButton (statement), CheckBox (statement), ComboBox (statement), Dialog (function), Dialog (statement), DropListBox (statement), GroupBox (statement), ListBox (statement), OKButton (statement), OptionButton (statement), OptionGroup (statement), Picture (statement), PushButton (statement), Text (statement), Begin Dialog (statement), PictureButton (statement)

H