Interface IDocument

Namespace

VirtualLabAPI.Core.Common

Assembly

VirtualLabAPI.dll

Interface implemented by all VirtualLab Fusion documents.

public interface IDocument : IEquatable<IObjectBase>, ICloneable

Inherited Members

IEquatable<IObjectBase>.Equals(IObjectBase)

ICloneable.Clone()

Extension Methods

FileHandlingSupport.SaveCompressed(IStorableOnHDD, string, ListOfSavedViewSettings)

Properties

Session

Every documents needs to be handled in a session. Default is the VirtualLab Main Session.

VirtualLabSession Session { get; set; }

Property Value

VirtualLabSession

TreeStructure

Every document should have a node (maybe with subnodes) in the VirtualLab Explorer.

NodeVLExplorer TreeStructure { get; }

Property Value

NodeVLExplorer

TypeOfDocument

Gets an enum entry specifying the type of the document.

DocumentType TypeOfDocument { get; }

Property Value

DocumentType

Methods

GetNewDocumentWindow(Form, string)

Gets a new document window containing this document.

FormDocument GetNewDocumentWindow(Form formMain, string fileName)

Parameters

formMain Form

Reference to the main form (= MDI parent). Can be null if this form will not be shown (e.g. if it is generated just to get the view settings.

fileName string

File name from which the document was opened for inserting into window caption. If this string is empty, the default document name is used.

Returns

FormDocument

A VirtualLabAPI.UI.BasicUI.FormDocument containing this document.