Interface IDataDisplay

Namespace

VirtualLabAPI.Core.Common

Assembly

VirtualLabAPI.dll

Interface providing methods to show documents or messages, usually in the main form. But you can implement this interface to show this data somewhere else.

public interface IDataDisplay : ILogMessages

Inherited Members

ILogMessages.LogMessage(ErrorWarningOrMessage)

ILogMessages.LogError(string)

ILogMessages.LogWarning(string)

ILogMessages.LogMessage(string)

ILogMessages.LogString(string)

Methods

LogDetectorResult(string, List<PhysicalValueBase>)

Writes a list of physical values into the Detector Results tab.

void LogDetectorResult(string detectorName, List<PhysicalValueBase> results)

Parameters

detectorName string

the name of the detector.

results List<PhysicalValueBase>

the results of the detector (including sub-detectors)

LogDetectorResult(string, List<PhysicalValue>)

Writes a list of real-valued physical values into the Detector Results tab.

void LogDetectorResult(string detectorName, List<PhysicalValue> results)

Parameters

detectorName string

the name of the detector.

results List<PhysicalValue>

the results of the detector (including sub-detectors)

ShowDocument(IDocument, bool)

Displays an IDocument in its document window. If there is no such window, an exception is thrown.

void ShowDocument(IDocument document, bool duplicateDocument = true)

Parameters

document IDocument

Document to show.

duplicateDocument bool

True: A copy of the document is shown.
False: The document is shown. This means that when you close the document window the document is also deleted.
This optional parameter is true by default.

ShowDocument(IDocument, string, bool)

Displays an IDocument in a document window that supports it. If there is no such window, an exception is thrown. Caption of window can be specified.

void ShowDocument(IDocument document, string caption, bool duplicateDocument = true)

Parameters

document IDocument

Document to show.

caption string

Caption of window.

duplicateDocument bool

True: A copy of the document is shown.
False: The document is shown. This means that when you close the document window the document is also deleted.
This optional parameter is true by default.

ShowDocumentAsync(IDocument, string, bool, Action<FormDocument>)

Method to asynchronously show a document in a new MDI child window. Especially useful for output of intermediate results in simulations.

void ShowDocumentAsync(IDocument document, string documentCaption = "", bool duplicateDocument = true, Action<FormDocument> changeFormAfterShow = null)

Parameters

document IDocument

Document to be shown.

documentCaption string

Optional document title to be shown in the window caption. Empty string by default.

duplicateDocument bool

True: A copy of the document is shown.
False: The document is shown. This means that when you close the document window the document is also deleted.
This optional parameter is true by default.

changeFormAfterShow Action<FormDocument>

Optional method which is called after the document window is shown. In this way you can change view settings of the form if required.

ShowNotification(string, ToolTipIcon)

Shows a notification as (balloon) tip in the taskbar notification area (at the right of the Windows™ taskbar).

void ShowNotification(string message, ToolTipIcon toolTipIcon)

Parameters

message string

The message to show.

toolTipIcon ToolTipIcon

The tool tip icon indicating the type of the message (error, warning, info, none). The ToolTipIcon.Info should be used if a simulation finished successfully, ToolTipIcon.None is reserved for future intermediate messages (e.g. "50 % of the simulation done", "switched propagation method" and so on).