Interface IMessageDisplayService
A display service for showing messages on the UI.
Namespace: Gorgon.Editor.Services
Assembly: Gorgon.Editor.API.dll
Syntax
public interface IMessageDisplayServiceMethods
| Edit this page View SourceShowConfirmation(string, string, bool, bool)
Function to show a confirmation message.
Declaration
MessageResponse ShowConfirmation(string message, string caption = null, bool toAll = false, bool allowCancel = false)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | The message to display. |
| string | caption | [Optional] A caption for the message. |
| bool | toAll | [Optional] true to allow an application to apply the result to all items, false to only allow an application to apply the result to a single item. |
| bool | allowCancel | [Optional] true to allow cancellation support, false to only allow accept or deny functionality. |
Returns
| Type | Description |
|---|---|
| MessageResponse | The response value for the message. |
ShowError(Exception, string, string)
Function to show an error message based on an exception.
Declaration
void ShowError(Exception ex, string message = null, string caption = null)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | ex | The exception to display. |
| string | message | [Optional] A custom message to display with the error. |
| string | caption | [Optional] A caption for the message. |
ShowError(string, string, string)
Function to show an error message with optional detail information.
Declaration
void ShowError(string message, string caption = null, string details = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | The message to display. |
| string | caption | [Optional] A caption for the message. |
| string | details | [Optional] Additional information for the error. |
ShowInfo(string, string)
Function to show an informational message.
Declaration
void ShowInfo(string message, string caption = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | The message to display. |
| string | caption | [Optional] A caption for the message. |
ShowWarning(string, string, string)
Function to show a warning message.
Declaration
void ShowWarning(string message, string caption = null, string details = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | The message to display. |
| string | caption | [Optional] A caption for the message. |
| string | details | [Optional] Additional information for the error. |