In This Article

IUserPromptService Interface

Enables the display of prompts intended for user interaction and/or notification.

public interface IUserPromptService : IDesignerSafeUserPromptService

Remarks

For internal use only.

Methods

BuildOpenFilePrompt()

Creates a new model which can be used to prompt the user to open a file.

IOpenFilePromptBuilder BuildOpenFilePrompt()

Returns

IOpenFilePromptBuilder

BuildSaveFilePrompt()

Creates a new model which can be used to prompt the user to save a file.

ISaveFilePromptBuilder BuildSaveFilePrompt()

Returns

ISaveFilePromptBuilder

ShowDialog(Form)

Displays the specified form in a dialog box.

DialogResult ShowDialog(Form form)
Parameter Type Description
form Form

The form to display.

Returns

DialogResult:

One of the DialogResult values indicating the result code of the user's interaction.

See Also

ShowDialogAsync(Form)

Displays the specified form in a modal dialog box.

Task<DialogResult> ShowDialogAsync(Form form)
Parameter Type Description
form Form

The form to display.

Returns

Task<DialogResult>:

A task which completes when the modal dialog is closed and whose result will be one of the DialogResult values indicating the result code of the user's interaction.

ShowFileOpen(IOpenFileOptions)

Displays a dialog prompting the user to open a file.

IOpenFileResult ShowFileOpen(IOpenFileOptions options)
Parameter Type Description
options IOpenFileOptions

The options defining the characteristics of the file prompt.

Returns

IOpenFileResult:

The result of the user interaction.

See Also

ShowFileSave(ISaveFileOptions)

Displays a dialog prompting the user to save a file.

ISaveFileResult ShowFileSave(ISaveFileOptions options)
Parameter Type Description
options ISaveFileOptions

The options defining the characteristics of the file prompt.

Returns

ISaveFileResult:

The result of the user interaction.

See Also

ShowMessageBox(string, string, MessageBoxButtons)

Displays the specified message in a message box with the specified caption and buttons to place on the dialog box.

DialogResult ShowMessageBox(string message, string caption, MessageBoxButtons buttons)
Parameter Type Description
message string

The message to display.

caption string

The caption for the dialog box.

buttons MessageBoxButtons

The buttons to be displayed.

Returns

DialogResult:

One of the DialogResult values indicating the result code of the user's interaction.

ShowMessageBox(string, string, MessageBoxButtons, MessageBoxIcon)

Displays the specified message in a message box with the specified caption and buttons to place on the dialog box.

DialogResult ShowMessageBox(string message, string caption, MessageBoxButtons buttons, MessageBoxIcon icon)
Parameter Type Description
message string

The message to display.

caption string

The caption for the dialog box.

buttons MessageBoxButtons

The buttons to be displayed.

icon MessageBoxIcon

The icon to be displayed.

Returns

DialogResult:

One of the DialogResult values indicating the result code of the user's interaction.

ShowMessageBox(string, string, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton)

Displays the specified message in a message box with the specified caption and buttons to place on the dialog box.

DialogResult ShowMessageBox(string message, string caption, MessageBoxButtons buttons, MessageBoxIcon icon, MessageBoxDefaultButton defaultButton)
Parameter Type Description
message string

The message to display.

caption string

The caption for the dialog box.

buttons MessageBoxButtons

The buttons to be displayed.

icon MessageBoxIcon

The icon to be displayed.

defaultButton MessageBoxDefaultButton

The default button for the message box.

Returns

DialogResult:

One of the DialogResult values indicating the result code of the user's interaction.

ShowMessageBox(IWin32Window, string, string, MessageBoxButtons)

Displays the specified message in a message box with the specified caption and buttons to place on the dialog box.

DialogResult ShowMessageBox(IWin32Window owner, string message, string caption, MessageBoxButtons buttons)
Parameter Type Description
owner IWin32Window

The owner of the message box.

message string

The message to display.

caption string

The caption for the dialog box.

buttons MessageBoxButtons

The buttons to be displayed.

Returns

DialogResult:

One of the DialogResult values indicating the result code of the user's interaction.

ShowMessageBox(IWin32Window, string, string, MessageBoxButtons, MessageBoxIcon)

Displays the specified message in a message box with the specified caption and buttons to place on the dialog box.

DialogResult ShowMessageBox(IWin32Window owner, string message, string caption, MessageBoxButtons buttons, MessageBoxIcon icon)
Parameter Type Description
owner IWin32Window

The owner of the message box.

message string

The message to display.

caption string

The caption for the dialog box.

buttons MessageBoxButtons

The buttons to be displayed.

icon MessageBoxIcon

The icon to be displayed.

Returns

DialogResult:

One of the DialogResult values indicating the result code of the user's interaction.

ShowMessageBox(IWin32Window, string, string, MessageBoxButtons, MessageBoxIcon, MessageBoxDefaultButton)

Displays the specified message in a message box with the specified caption and buttons to place on the dialog box.

DialogResult ShowMessageBox(IWin32Window owner, string message, string caption, MessageBoxButtons buttons, MessageBoxIcon icon, MessageBoxDefaultButton defaultButton)
Parameter Type Description
owner IWin32Window

The owner of the message box.

message string

The message to display.

caption string

The caption for the dialog box.

buttons MessageBoxButtons

The buttons to be displayed.

icon MessageBoxIcon

The icon to be displayed.

defaultButton MessageBoxDefaultButton

The default button for the message box.

Returns

DialogResult:

One of the DialogResult values indicating the result code of the user's interaction.

Inherited Members