Programming Reference for VirtualLab Fusion  2025.1
Loading...
Searching...
No Matches
IDocument Interface Reference

Interface implemented by all VirtualLab documents. More...

Inheritance diagram for IDocument:
HarmonicFieldBase IRegion1D2D ComplexAmplitude Region1D Region2D ComposedRegion1D IntervalRegion SampledRegion1D ComposedRegion2D ElementaryRegion2D SampledRegion2D EllipticRegion RectangularRegion SimplePolygon

Public Member Functions

FormDocument GetNewDocumentWindow (Form formMain, string fileName)
 Gets a new document window containing this document.
 

Properties

VirtualLabSession Session [get, set]
 every documents need to be handled in a session ==> default is the VirtualLab Mainsession
 
NodeVLExplorer TreeStructure [get]
 every document should have a node (maybe with subnodes) in the VirtualLab Explorer
 
DocumentType TypeOfDocument [get]
 Gets an enum entry specifying the type of the document.
 

Detailed Description

Interface implemented by all VirtualLab documents.

Member Function Documentation

◆ GetNewDocumentWindow()

FormDocument GetNewDocumentWindow ( Form  formMain,
string  fileName 
)

Gets a new document window containing this document.

Parameters
formMainReference 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.
fileNameFile name from which the document was opened for inserting into window caption. If this string is empty, the default document name is used.
Returns
A FormDocument containing this document.

Implemented in Region1D, and Region2D.