IActiveDocumentHistory Interface Reference

Interface providing access to documents in current VirtualLab session. More...

Public Member Functions
IDocument	BrowseLastDocuments (DocumentFilter formType, out int index, string info, bool getReference=false)
	Opens an dialog to choose one open document.
IDocument	GetLastDocument (int index, DocumentFilter formType)
	Gets the document matching the given filtering parameters.
IDocument	GetLastDocument (int index, DocumentType documentType, bool returnReference=false)
	Gets the document matching the given filtering parameters.
int	GetLastDocumentCounter (int index, DocumentFilter formType)
	Gets the window number of the document matching the given filtering parameters. This is the number always shown in the caption of a document window.
string	GetLastFormDocumentTitle (int index, DocumentFilter formType, bool fullTitle)
	Gets the title of the document matching the given filtering parameters.
int	GetNumberOfDocuments (DocumentFilter formType)
	Returns number of FormDocuments of a given type available in current session of VirtualLab.

Detailed Description

Interface providing access to documents in current VirtualLab session.

Member Function Documentation

BrowseLastDocuments()

IDocument BrowseLastDocuments	(	DocumentFilter	formType,
		out int	index,
		string	info,
		bool	getReference = false
	)

Opens an dialog to choose one open document.

Parameters

formType	Type of document to look for.
index	Out parameter giving the position of the selected document in the list of recently activated documents.
info	Written in caption of the selection dialog.
getReference	flag whether only reference of the document shall be returned

Returns

Document contained in choosen FormDocument.

GetLastDocument() [1/2]

IDocument GetLastDocument	(	int	index,
		DocumentFilter	formType
	)

Gets the document matching the given filtering parameters.

Parameters

index	Index 0 means the most recently activated document passing the filter, index 1 means the document activated before the most recently activated document...
formType	Type of document to look for.

Returns

Result of operation.

GetLastDocument() [2/2]

IDocument GetLastDocument	(	int	index,
		DocumentType	documentType,
		bool	returnReference = false
	)

Gets the document matching the given filtering parameters.

Parameters

index	Index 0 means the most recently activated document passing the filter, index 1 means the document activated before the most recently activated document�
documentType	Type of document to look for.
returnReference	If this optional parameter is set to true a reference is returned. Otherwise the document a deep copy of the document is returned.

Returns

The matching document.

GetLastDocumentCounter()

int GetLastDocumentCounter	(	int	index,
		DocumentFilter	formType
	)

Gets the window number of the document matching the given filtering parameters. This is the number always shown in the caption of a document window.

Parameters

index	Index 0 means the most recently activated document passing the filter, index 1 means the document activated before the most recently activated document...
formType	Type of document to look for.

Returns

Result of operation.

GetLastFormDocumentTitle()

string GetLastFormDocumentTitle	(	int	index,
		DocumentFilter	formType,
		bool	fullTitle
	)

Gets the title of the document matching the given filtering parameters.

Parameters

index	Index 0 means the most recently activated document passing the filter, index 1 means the document activated before the most recently activated document...
formType	Type of document to get title for.
fullTitle	Include total number and modification asterisk if attached or not: (true \(\rightarrow\) "45: Gauss[*]" or false \(\rightarrow\) "Gauss").

Returns

Result of operation.

GetNumberOfDocuments()

int GetNumberOfDocuments

(

DocumentFilter

formType

)

Returns number of FormDocuments of a given type available in current session of VirtualLab.

Parameters

formType

Type of document to be counted.

Returns

Result of operation.