Class Log
The global object which receives logging messages that be shown to the user at the finish of postprocessing.
Namespace: DotnetPostprocessing.SDK
Assembly: DotnetPostprocessing.SDK.dll
Syntax
public static class Log : ObjectProperties
Receiver
The link to an object which actually keeps the logs.
Declaration
public static IPostprocessingLogReceiver Receiver { get; set; }Property Value
| Type | Description |
|---|---|
| IPostprocessingLogReceiver |
Methods
Error(string)
Adds an error message to the list of logs.
Declaration
public static void Error(string Msg)Parameters
| Type | Name | Description |
|---|---|---|
| string | Msg | The text of the message. |
Exception(Exception)
Adds a message about exception in the programm to the list of logs.
Declaration
public static void Exception(Exception e)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | e | The link to exception. |
Info(string)
Adds some informational message to the list of logs.
Declaration
public static void Info(string Msg)Parameters
| Type | Name | Description |
|---|---|---|
| string | Msg | The text of the message. |
MessageBox(string, string)
Shows the standard message box window immediately.
Declaration
public static MsgClickedBtn MessageBox(string message, string caption)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | The text of the message. |
| string | caption | The header for the window. |
Returns
| Type | Description |
|---|---|
| MsgClickedBtn | Returns the type of button the user clicked. |
MessageBox(string, string, MsgType)
Shows the standard message box window immediately.
Declaration
public static MsgClickedBtn MessageBox(string message, string caption, MsgType messageType)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | The text of the message. |
| string | caption | The header for the window. |
| MsgType | messageType | The type of message (error, question, warning, info). |
Returns
| Type | Description |
|---|---|
| MsgClickedBtn | Returns the type of button the user clicked. |
MessageBox(string, string, MsgType, MsgBtnSet, MsgDefBtn)
Shows the standard message box window immediately.
Declaration
public static MsgClickedBtn MessageBox(string message, string caption, MsgType messageType, MsgBtnSet buttons, MsgDefBtn defaultButton)Parameters
| Type | Name | Description |
|---|---|---|
| string | message | The text of the message. |
| string | caption | The header for the window. |
| MsgType | messageType | The type of message (error, question, warning, info). |
| MsgBtnSet | buttons | The set of buttons that should be shown in the window. |
| MsgDefBtn | defaultButton | The button that should be default. |
Returns
| Type | Description |
|---|---|
| MsgClickedBtn | Returns the type of button the user clicked. |
Warning(string)
Adds some warning message to the list of logs.
Declaration
public static void Warning(string Msg)Parameters
| Type | Name | Description |
|---|---|---|
| string | Msg | The text of the message. |