[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index]

Reference for unit 'Dialogs' (#lcl)

MessageDlgPosHelp

An extended MessageDlgPos function.

Declaration

Source position: dialogs.pp line 709

function MessageDlgPosHelp(

const aMsg: string;

DlgType: TMsgDlgType;

HelpCtx: LongInt;

const HelpFileName: string

):TModalResult; overload;

`aMsg`		The message to be shown.
`DlgType`		The type of dialog to be shown.
`Buttons`		Determines the buttons shown on the message dialog.
`HelpCtx`		HelpCtx is used to specify which topic from the help should be shown.
`X`		X specifies the position of the left side of the dialog.
`Y`		Y specifies the position of the top side of the dialog.
`HelpFileName`		The Helpfile that has to be shown when the user presses F1

The result of this function is the button the user pressed to close the dialog expressed as an integer.

If the user clicks the [X]-bordericon, the return value will be mrCancel.

If the user presses the escape key, the result depends on the widgetset:

If the widgetset has implemented a native dialog, the result will be mrCancel.
Otherwise the result will be mrCancel, mrNo or mrOk (in that order) if mbCancel, mbNo or mbOk is present. The dialog will not close when the Escape key is pressed if none of these buttons are present.

This function enables you to specify a Helpfile which has to be shown when the user presses F1.

Version 3.2

Generated 2024-02-25