ShowDialog

Description

Event handler called when a dialog is shown.
 

Syntax

[C#/C++]
public Long *ShowDialog(BSTR Title, BSTR Text, BSTR CheckBoxText, Long Options, Bool *DontAskChecked, Bool StayOnTop);

[VB.NET]
Public Function ShowDialog(ByVal Title As String, ByVal Text As String, ByVal CheckBoxText As String, ByVal Options As Integer, ByRef DontAskChecked As Boolean, ByVal StayOnTop As Boolean) ByRef As Integer;
 

Parameters

Title - text shown in the title bar of the dialog.

Text - text shown in the main body of the dialog.

CheckBoxText - the label of the checkbox displayed under the main text. Usually the label is something like "Don't show this message next time.".

Options - defines the buttons and icons to be displayed on the dialog. As used by the Win32 API call MessageBox.

DontAskChecked - event handling code can set this to True to not have this box displayed in the same situation next time.

StayOnTop - set to True if the dialog is of type Stay-on-top.
 

Return Value

Return a value indicating which button was pushed, containing values as returned from the Win32 API call MessageBox.
 

Setting the event handler

[C#]
Long * MyShowDialog(BSTR Title, BSTR Text, BSTR CheckBoxText, Long Options, Bool* DontAskChecked, Bool StayOnTop);
{}

editor.ShowDialog += new IFBEditorEvents_ShowDialogEventHandler(MyShowDialog);
 

[VB]
AddHandler fbEditor.ShowDialog, AddressOf MyShowDialog
 

[Delphi]
FBEditor.OnShowDialog := MyShowDialog;
 

[C++ Builder]
Editor->OnShowDialog = MyShowDialog;

 

See Also

FBEditor::PlayEvent   FBEditor::StopEvent