Interface IDebugWindow

Debug output shown in the GUI.

Namespace: Softadmin.Api.Ui

Assembly: Softadmin.Api.dll

Syntax

public interface IDebugWindow

Remarks

The debug window is intended to be used to print diagnostics useful for a troubleshooting developer. It should not be used as an interface for the end-user.

Properties

IsAvailable

Gets a value indicating whether there is a visible debug window to write messages to.

Declaration

bool IsAvailable { get; }

Property Value

Type	Description
System.Boolean

Remarks

The debug window is only available if the menu item has been configured to print debug output. You can use this property to avoid building debug messages when they are not needed, though that optimization will only be useful when debug messages are expensive to create.

Methods

Write(String)

Writes a basic debug message.

Declaration

void Write(string messageText)

Parameters

Type	Name	Description
System.String	messageText	Debug message.

Write(String, String)

Writes a debug message.

Declaration

void Write(string titleText, string messageText)

Parameters

Type	Name	Description
System.String	titleText	Message title.
System.String	messageText	Message details.