C# Class ACAT.Lib.Extension.DialogUtils

Contains useful utility cover functions such as Yes/No confirmation dialogs, Timed dialogs, Toast Dialog, launching functional agents etc.
Show file Open project: brlima94/acat-localization

Public Methods

Method Description
Confirm ( IPanel parent, String caption, String title = null ) : bool

Displays a yes no confirmation dialog box
Confirm ( String caption ) : bool

Displays a yes no confirmation dialog box
Confirm ( String caption, String title ) : bool

Displays a yes no confirmation dialog box.
ConfirmScanner ( IPanel parent, String caption ) : bool

Displays yes/no confirmation as a contextual menu scanner
ConfirmScanner ( String caption ) : bool

Displays yes/no confirmation as a contextual menu scanner
ConfirmScannerNarrow ( IPanel parent, String caption, String title = null ) : bool

Displays yes/no confirmation as a narrow contextual menu scanner
ConfirmScannerNarrow ( String caption ) : bool

Displays yes/no confirmation as a narrow contextual menu scanner
LaunchVolumeSettingsAgent ( ) : void

Runs the volume settings agent to control the volume of text to speech
ShowAboutBox ( Form parentForm, String logo, String appName, String versionInfo, String copyrightInfo, IEnumerable attributions ) : void

Displays the About box
ShowAppLauncher ( ) : void

Activates the functional agent responsible for launching applications
ShowFileBrowser ( ) : void

Activates the File Browser functional agent.
ShowTaskSwitcher ( string taskName = "" ) : void

Activates the Switch Windows functional agent to enable the user to switch windows/apps. If taskname is not null, it only shows windows belonging to the task (eg notepad, word)
ShowTaskSwitcherAltTab ( String taskName = "" ) : void

Displays the task switcher form which is the Alt-Tab equivalent to switch between application windows. If taskname is not null, it only shows windows belonging to the task (eg notepad, word)
ShowTimedDialog ( Form parentForm, String message ) : void

Shows the TimedDialog window
ShowTimedDialog ( Form parentForm, String title, String message ) : void

Shows the TimedDialog window
Toast ( String message, int timeout = 2000 ) : void

Displays a toast message centered in the parent form.

Private Methods

Method Description
initYesNoDialog ( String title, String caption ) : Form

Creates the Yes/No dialog form
initYesNoScanner ( String panelClass, String title, String caption ) : Form

Creates the Yes/No scanner form
showYesNoScanner ( IPanel parent, String panelClass, String caption ) : bool

Creates the yes/no scanner form and shows it as a dialog. Returns the result of the user choice

Method Details

Confirm() public static method

Displays a yes no confirmation dialog box
public static Confirm ( IPanel parent, String caption, String title = null ) : bool
parent IPanel parent scanner
caption String prompt string
title String title of the dialog
return bool

Confirm() public static method

Displays a yes no confirmation dialog box
public static Confirm ( String caption ) : bool
caption String Prompt string
return bool

Confirm() public static method

Displays a yes no confirmation dialog box.
public static Confirm ( String caption, String title ) : bool
caption String Prompt string
title String title of the dialog
return bool

ConfirmScanner() public static method

Displays yes/no confirmation as a contextual menu scanner
public static ConfirmScanner ( IPanel parent, String caption ) : bool
parent IPanel parent scanner
caption String prompt string
return bool

ConfirmScanner() public static method

Displays yes/no confirmation as a contextual menu scanner
public static ConfirmScanner ( String caption ) : bool
caption String prompt string
return bool

ConfirmScannerNarrow() public static method

Displays yes/no confirmation as a narrow contextual menu scanner
public static ConfirmScannerNarrow ( IPanel parent, String caption, String title = null ) : bool
parent IPanel parent scanner
caption String prompt string
title String scanner title
return bool

ConfirmScannerNarrow() public static method

Displays yes/no confirmation as a narrow contextual menu scanner
public static ConfirmScannerNarrow ( String caption ) : bool
caption String prompt string
return bool

LaunchVolumeSettingsAgent() public static method

Runs the volume settings agent to control the volume of text to speech
public static LaunchVolumeSettingsAgent ( ) : void
return void

ShowAboutBox() public static method

Displays the About box
public static ShowAboutBox ( Form parentForm, String logo, String appName, String versionInfo, String copyrightInfo, IEnumerable attributions ) : void
parentForm System.Windows.Forms.Form parent form
logo String filename of the logo to display
appName String Name of the assembly
versionInfo String version information
copyrightInfo String copyright info
attributions IEnumerable 3rd party attributions
return void

ShowAppLauncher() public static method

Activates the functional agent responsible for launching applications
public static ShowAppLauncher ( ) : void
return void

ShowFileBrowser() public static method

Activates the File Browser functional agent.
public static ShowFileBrowser ( ) : void
return void

ShowTaskSwitcher() public static method

Activates the Switch Windows functional agent to enable the user to switch windows/apps. If taskname is not null, it only shows windows belonging to the task (eg notepad, word)
public static ShowTaskSwitcher ( string taskName = "" ) : void
taskName string filter by this process name
return void

ShowTaskSwitcherAltTab() public static method

Displays the task switcher form which is the Alt-Tab equivalent to switch between application windows. If taskname is not null, it only shows windows belonging to the task (eg notepad, word)
public static ShowTaskSwitcherAltTab ( String taskName = "" ) : void
taskName String filter by this process name
return void

ShowTimedDialog() public static method

Shows the TimedDialog window
public static ShowTimedDialog ( Form parentForm, String message ) : void
parentForm System.Windows.Forms.Form parent form
message String message to display
return void

ShowTimedDialog() public static method

Shows the TimedDialog window
public static ShowTimedDialog ( Form parentForm, String title, String message ) : void
parentForm System.Windows.Forms.Form parent form
title String title of the dialog
message String message to display
return void

Toast() public static method

Displays a toast message centered in the parent form.
public static Toast ( String message, int timeout = 2000 ) : void
message String message to display
timeout int how long to display
return void