IDialogService
The IDialogService provides methods for displaying modal dialogs to the user, including confirmation prompts, error messages, informational notices, success notifications, and warnings.
Injecting the Service
Access the dialog service from any component. In React call useDialogService() from inside the tree wrapped by the framework dialog provider; in Blazor inject the service via property injection. Note that the PowerPortalsPro dialog service is distinct from the underlying FluentUI dialog service.
Confirmation Dialogs
Use ShowConfirmationAsync to prompt the user with a yes/no question. The returned DialogResult.Cancelled property is true when the user selects the secondary (negative) option.
Message Dialogs
Use the following methods to show single-button message dialogs with different visual styles:
ShowInfoAsync— Informational message with a neutral icon.ShowSuccessAsync— Success message with a green checkmark icon.ShowWarningAsync— Warning message with a yellow warning icon.ShowErrorAsync— Error message with a red error icon.
Common Parameters
All dialog methods accept optional title and primaryText parameters. If omitted, localized default values are used. The confirmation dialog also accepts a secondaryText parameter for the cancel button label.
Dialog Result
All methods return a DialogResult object. For confirmation dialogs, check the Cancelled property to determine the user's choice. For message dialogs, the result indicates the dialog was dismissed.
Interactive Demo
Use the controls below to customize the dialog title and message, then click any button to see the corresponding dialog type.
IDialogService Interface
Methods
Name | Parameters | Type | Description |
|---|---|---|---|
ShowConfirmationAsync | string message string title string primaryText string secondaryText | Task<DialogResult> | Shows a confirmation dialog with the supplied message and two action buttons, then waits for the user to choose one. The returned Services.DialogResult has DialogResult.Cancelled set to |
ShowErrorAsync | string message string title string primaryText | Task<DialogResult> | Shows an error dialog with the supplied message and waits for the user to dismiss it. |
ShowInfoAsync | string message string title string primaryText | Task<DialogResult> | Shows an informational dialog with the supplied message and waits for the user to dismiss it. |
ShowSuccessAsync | string message string title string primaryText | Task<DialogResult> | Shows a success dialog with the supplied message and waits for the user to dismiss it. |
ShowWarningAsync | string message string title string primaryText | Task<DialogResult> | Shows a warning dialog with the supplied message and waits for the user to dismiss it. |
Name:
ShowConfirmationAsyncParameters:
string message
string title
string primaryText
string secondaryText
string title
string primaryText
string secondaryText
Type:
Task<DialogResult>
Description:
Shows a confirmation dialog with the supplied true when the user selects the secondary (negative) option.
message and two action buttons, then waits for the user to choose one. The returned Services.DialogResult has DialogResult.Cancelled set to Name:
ShowErrorAsyncParameters:
string message
string title
string primaryText
string title
string primaryText
Type:
Task<DialogResult>
Description:
Shows an error dialog with the supplied
message and waits for the user to dismiss it.Name:
ShowInfoAsyncParameters:
string message
string title
string primaryText
string title
string primaryText
Type:
Task<DialogResult>
Description:
Shows an informational dialog with the supplied
message and waits for the user to dismiss it.Name:
ShowSuccessAsyncParameters:
string message
string title
string primaryText
string title
string primaryText
Type:
Task<DialogResult>
Description:
Shows a success dialog with the supplied
message and waits for the user to dismiss it.Name:
ShowWarningAsyncParameters:
string message
string title
string primaryText
string title
string primaryText
Type:
Task<DialogResult>
Description:
Shows a warning dialog with the supplied
message and waits for the user to dismiss it.DialogResult Class
Properties
Name | Type | Default | Description |
|---|---|---|---|
Cancelled | bool | False | Gets a value indicating whether the dialog was cancelled (e.g. the user dismissed it without confirming). |
Data | Object? | Optional data payload returned by the dialog when it was closed. |
Name:
CancelledType:
bool
Default:
False
Description:
Gets a value indicating whether the dialog was cancelled (e.g. the user dismissed it without confirming).
Name:
DataType:
Object?
Description:
Optional data payload returned by the dialog when it was closed.
Methods
Name | Parameters | Type | Description |
|---|---|---|---|
Cancel | Object data | DialogResult | Creates a Services.DialogResult representing a cancelled outcome, optionally carrying a data payload. |
Ok<T> | T result | DialogResult | Creates a Services.DialogResult representing a confirmed outcome, carrying result as the data payload. |
Name:
CancelParameters:
Object data
Type:
DialogResult
Description:
Creates a
Services.DialogResult representing a cancelled outcome, optionally carrying a data payload.Name:
Ok<T>Parameters:
T result
Type:
DialogResult
Description:
Creates a
Services.DialogResult representing a confirmed outcome, carrying result as the data payload.