Table of Contents

Method ShowUI

Namespace
Skyline.DataMiner.Automation
Assembly
SLManagedAutomation.dll

ShowUI(string)

Displays a custom-made dialog box of an interactive Automation script.

public UIResults ShowUI(string uiData)

Parameters

uiData string

The UI data.

Returns

UIResults

The UI result.

Examples

UIBuilder uib = new UIBuilder();
...
// Add dialog box items to the dialog box
UIBlockDefinition blockButton = new UIBlockDefinition();
blockButton.Type = UIBlockType.Button;
...
engine.ShowUI(uib.ToString());

Exceptions

InteractiveUserDetachedException

The interactive client was detached.

DataMinerException

Show UI failed.

ShowUI(UIBuilder)

Displays a custom-made dialog box of an interactive Automation script.

public UIResults ShowUI(UIBuilder uiBuilder)

Parameters

uiBuilder UIBuilder

The UIBuilder instance representing a dialog box of an interactive automation script.

Returns

UIResults

The UI result.

Examples

UIBuilder uib = new UIBuilder();
...
// Add dialog box items to the dialog box
UIBlockDefinition blockButton = new UIBlockDefinition();
blockButton.Type = UIBlockType.Button;
...
engine.ShowUI(uib);

Exceptions

InteractiveUserDetachedException

The interactive client was detached.

DataMinerException

Show UI failed.

ShowUI(string, bool)

Displays a custom-made dialog box of an interactive Automation script.

public UIResults ShowUI(string uiData, bool requireResponse)

Parameters

uiData string

The UI data.

requireResponse bool

Indicates whether a response is required.

Returns

UIResults

The UI result.

Examples

UIBuilder uib = new UIBuilder();
...
// Add dialog box items to the dialog box
UIBlockDefinition blockButton = new UIBlockDefinition();
blockButton.Type = UIBlockType.Button;
...
engine.ShowUI(uib.ToString(), uib.RequireResponse);

Exceptions

InteractiveUserDetachedException

The interactive client was detached.

DataMinerException

Show UI failed.

Propose changes