UModel API

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

The UModel API > API Reference > UModel API Interfaces

UModelAPI - IDocument

Interface IDocument

diagram

typedElements

Interface _IApplicationEvents	Operation	OnDocumentClosed OnDocumentOpened OnNewDocument
Interface _IDocumentEvents	Operation	OnAfterReloadDocument OnBeforeReloadDocument OnDocumentClosed OnDocumentSaved OnDocumentSavedAs OnModifiedFlagChanged
Interface _ITransactionEvents	Operation	OnBeginDataModification OnEndDataModification
Interface IApplication	Operation	ActiveDocument ImportFromXMIFile ImportFromXMIFileFromURL NewDocument OpenDocument OpenDocumentFromURL

Operation IDocument::AbortModification

parameter

name	direction	type	type modifier	multiplicity	default
return	return	void

Operation IDocument::ActiveDiagramWindow

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IDiagramWindow

Operation IDocument::Application

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IDispatch

Operation IDocument::BeginModification

parameter

name	direction	type	type modifier	multiplicity	default
return	return	bool

Operation IDocument::CanFocusUMLDataInModelTree

parameter

name	direction	type	type modifier	multiplicity	default
ipUMLData	in	IUMLData
return	return	bool

Operation IDocument::CheckProjectSyntax

parameter

name	direction	type	type modifier	multiplicity	default
return	return	bool

Operation IDocument::DiagramWindows

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IDiagramWindows

Operation IDocument::ElementFamilyStyles

parameter

name	direction	type	type modifier	multiplicity	default
strKind	in	string
return	return	IUMLGuiStyles

Operation IDocument::EndModification

parameter

name	direction	type	type modifier	multiplicity	default
return	return	void

Operation IDocument::ExportToXMIFile

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IExportXMIFileDlg
return	return	bool

Operation IDocument::FocusedUMLData

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLData

documentation

Get the focused UML data of the docoument.

Normally this is the one which is shown in the "Properties" window.

Operation IDocument::FocusedUMLDataNotifier

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IFocusedUMLDataNotifier

Operation IDocument::FocusUMLDataInModelTree

parameter

name	direction	type	type modifier	multiplicity	default
ipUMLData	in	IUMLData
bFocusModelTree	in	bool
bEnsureModelTreeVisible	in	bool
return	return	void

Operation IDocument::FullName

parameter

name	direction	type	type modifier	multiplicity	default
return	return	string

Operation IDocument::GenerateDocumentation

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IGenerateDocumentationDlg
strResultFile	in	string
return	return	bool

Operation IDocument::GenerateSequenceDiagram

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IGenerateSequenceDiagramDlg
ipOp	in	IUMLOperation
return	return	bool

Operation IDocument::GenerateSequenceDiagramsForAllOperations

parameter

name	direction	type	type modifier	multiplicity	default
bAllPublicOnly	in	bool
bIncludeGettersAndSetters	in	bool
return	return	void

Operation IDocument::GenerateStateMachineCode

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IGenerateStateMachineCodeDlg
ipStateMachine	in	IUMLStateMachine
return	return	bool

Operation IDocument::GuiRoot

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiRootElement

Operation IDocument::ImportBinaryTypes

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IImportBinaryTypesDlg
return	return	bool

Operation IDocument::ImportDatabase

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IImportDatabaseDlg
return	return	bool

Operation IDocument::ImportSourceDirectory

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IImportSourceDirectoryDlg
return	return	bool

Operation IDocument::ImportSourceProject

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IImportSourceProjectDlg
return	return	bool

Operation IDocument::ImportXMLSchemaDirectory

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IImportXMLSchemaDirectoryDlg
return	return	bool

Operation IDocument::ImportXMLSchemaFile

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IImportXMLSchemaFileDlg
return	return	bool

Operation IDocument::IncludeSubproject

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IIncludeSubprojectDlg
return	return	bool

Operation IDocument::IsInUndoRedo

parameter

name	direction	type	type modifier	multiplicity	default
return	return	bool

Operation IDocument::IsLoadedFromPreviousFileFormat

parameter

name	direction	type	type modifier	multiplicity	default
return	return	bool

documentation

True, when the document has been loaded from a project file with a previous file format version. When saving the document, previous versions of UModel will not be able to load this file anymore.

Operation IDocument::LineStyles

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiStyles

Operation IDocument::MergeProject

parameter

name	direction	type	type modifier	multiplicity	default
strProjectFile	in	string
return	return	bool

Operation IDocument::MergeProject3Way

parameter

name	direction	type	type modifier	multiplicity	default
strProjectFile	in	string
strCommonAncestorFile	in	string
return	return	bool

Operation IDocument::MergeProjectFromURL

parameter

name	direction	type	type modifier	multiplicity	default
IURLDlg	in	IURLDlg
return	return	bool

Operation IDocument::ModelTransformation

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IModelTransformationDlg
return	return	bool

Operation IDocument::ModifiedFlag

parameter

name	direction	type	type modifier	multiplicity	default
return	return	bool

Operation IDocument::Name

parameter

name	direction	type	type modifier	multiplicity	default
return	return	string

Operation IDocument::NodeStyles

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiStyles

Operation IDocument::OpenAllDiagrams

parameter

name	direction	type	type modifier	multiplicity	default
return	return	void

Operation IDocument::OpenDiagram

parameter

name	direction	type	type modifier	multiplicity	default
ipUMLDiagram	in	IUMLGuiDiagram
return	return	IDiagramWindow

Operation IDocument::Parent

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IDispatch

Operation IDocument::Path

parameter

name	direction	type	type modifier	multiplicity	default
return	return	string

Operation IDocument::ProjectSettings

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	IProjectSettingsDlg
return	return	void

Operation IDocument::ProjectStyles

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLGuiStyles

Operation IDocument::Reload

parameter

name	direction	type	type modifier	multiplicity	default
return	return	bool

Operation IDocument::RootPackage

parameter

name	direction	type	type modifier	multiplicity	default
return	return	IUMLPackage

Operation IDocument::Save

parameter

name	direction	type	type modifier	multiplicity	default
return	return	void

Operation IDocument::SaveAllDiagramsAsImages

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	ISaveAllDiagramsAsImagesDlg
return	return	bool

Operation IDocument::SaveAs

parameter

name	direction	type	type modifier	multiplicity	default
strFileName	in	string
return	return	void

Operation IDocument::SaveCopyAs

parameter

name	direction	type	type modifier	multiplicity	default
strFileName	in	string
return	return	void

Operation IDocument::Saved

parameter

name	direction	type	type modifier	multiplicity	default
return	return	bool

Operation IDocument::SaveToURL

parameter

name	direction	type	type modifier	multiplicity	default
IURLDlg	in	IURLDlg
return	return	void

Operation IDocument::SynchronizationSettings

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	ISynchronizationSettingsDlg
return	return	void

Operation IDocument::SynchronizeCodeFromModel

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	ISynchronizationSettingsDlg
return	return	bool

Operation IDocument::SynchronizeModelFromCode

parameter

name	direction	type	type modifier	multiplicity	default
ipDlg	in	ISynchronizationSettingsDlg
return	return	bool

Operation IDocument::TransactionNotifier

parameter

name	direction	type	type modifier	multiplicity	default
return	return	ITransactionNotifier

UML documentation generated by UModel UML Editor http://www.altova.com/umodel

Thu Apr 30 14:03:32 2026

Please enable JavaScript to view this site.

UModel API