Document Class

The Document Class represents an loaded EasyMap document file (empx).

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.Runtime.InteropServicesStandardOleMarshalObject
      BaseObject
        Wrapper
          Easymap.AddInDocument

Namespace: Easymap.AddIn
Assembly: EasyMap.AddIn (in EasyMap.AddIn.dll) Version: 12.3.0.0

Syntax

public sealed class Document : Wrapper, 
	IWin32Window

Public NotInheritable Class Document
	Inherits Wrapper
	Implements IWin32Window

The Document type exposes the following members.

Properties

	Name	Description
	Analysis	List of analysis objects.
	CurrentSheet	Returns the currently active Sheet
	DataSources	List of DataSources.
	DocumentFunctions	Provides common functions
	DocumentMetadata	Contains common metadata like author, last saved date, etc.
	DocumentVariables	Contains user-defined variables, which can be used in macros.
	Export	Export the Document to images or office formats.
	Factories	Create and Add Elements to the Document.
	Filename	Gets or sets the filename used to save the document. If this property is not set the SaveAs file dialog will be displayed when the document is saved.
	Modified	Gets, Sets the modified state of the document. If the document is modified the user will be asked to save it when closed.
	Nodes	Contains additional items.
	Reports	The collection of Reports of this workbook
	Sheets	List of Sheets.
	Show	Shows or hides the document window.
	Title	The Title of the document (as shown in the Title bar).
	Views	List of Views.

Methods

	Name	Description
	Close	Close the document. If the document is modified it will be saved using the default save logic (see save).
	Close(Boolean)	Close the Document.
	Delete	Deletes an element.
	Dispose	Releases all resources used by the Document (Overrides Wrapper.Dispose)
	FindByCaption	Finds an Component by its caption.
	FindByName	Finds an Component by its name.
	FindElementByCaptionPath	Finds an Element (Sheet or WindowlessComponent) by it's path.
	GetProperties	Gets a PropertyBag for the specified key.
	ReleaseFile	Releases the write lock on the Document File (empx).
	Save	Writes the document to the file specified by the Filename property. The SaveAs file dialog is displayed if the filename property is not set or the document/file is readonly
	Save(Boolean)	Saves the document to the file specified by the Filename property.

Events