## On this page # Class Document Last update: 09.03.2026 Namespace: [VM.Managed](VM.Managed.md) Assembly: VMAppCore.dll This class is to represent the document. ```csharp public abstract class Document : Container, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IEnableManager, IRelatedDocument, IHistorySupport ``` #### Inheritance object ← ObservableObject ← [LinkableBase](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/Pre/Data/VM.Models.Pre/Models/LinkableBase.cs) ← [LinkContainer](VM.Managed.LinkContainer.md) ← [Container](VM.Managed.Container.md) ← [Document](VM.Managed.Document.md) #### Derived [ControlDocument](VM.Managed.ControlDocument.md), [HandledDocument](VM.Managed.HandledDocument.md) #### Implements IObservableObject, IDisposableObject, ILinkable, [ILinkContainerEvent](VM.Managed.ILinkContainerEvent.md), [IVerifiable](VM.Managed.IVerifiable.md), IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, [IEnableManager](VM.Managed.IEnableManager.md), [IRelatedDocument](VM.Managed.IRelatedDocument.md), [IHistorySupport](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMHist/Interfaces.cs) #### Inherited Members [Container.Find(string)](VM.Managed.Container.md#VM_Managed_Container_Find_System_String_), [Container.FindLocal(string)](VM.Managed.Container.md#VM_Managed_Container_FindLocal_System_String_), [Container.GetUnnamedObjectName(object)](VM.Managed.Container.md#VM_Managed_Container_GetUnnamedObjectName_System_Object_), [Container.GetNewEntityName(string, bool, int, int)](VM.Managed.Container.md#VM_Managed_Container_GetNewEntityName_System_String_System_Boolean_System_Int32_System_Int32_), [Container.GetNewEntityName(string, bool, int)](VM.Managed.Container.md#VM_Managed_Container_GetNewEntityName_System_String_System_Boolean_System_Int32_), [Container.GetNewEntityName(string)](VM.Managed.Container.md#VM_Managed_Container_GetNewEntityName_System_String_), [LinkContainer.SetModified()](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_SetModified), [LinkContainer.raise\_OnUpdating(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_raise_OnUpdating_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.raise\_OnUpdate(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_raise_OnUpdate_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.raise\_OnDestroying(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_raise_OnDestroying_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.raise\_OnDestroy(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_raise_OnDestroy_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.raise\_OnAdded(object, AddToDocEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_raise_OnAdded_System_Object_VM_Managed_AddToDocEventArgs_), [LinkContainer.raise\_OnRemoved(object, RemoveFromDocEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_raise_OnRemoved_System_Object_VM_Managed_RemoveFromDocEventArgs_), [LinkContainer.GetTargetListForUpdate()](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_GetTargetListForUpdate), [LinkContainer.SkipUpdateObjectImpl()](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_SkipUpdateObjectImpl), [LinkContainer.Initialize(Unit.ConvertFactor)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_Initialize_VM_Unit_ConvertFactor_), [LinkContainer.SetFlagWhenXMLFile(string, bool)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_SetFlagWhenXMLFile_System_String_System_Boolean_), [LinkContainer.IsSerializableEvent(Delegate)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_IsSerializableEvent_System_Delegate_), [LinkContainer.CustomGetObjectData(SerializationInfo, StreamingContext)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_CustomGetObjectData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_), [LinkContainer.GetSerializedData(SerializationInfo, StreamingContext)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_GetSerializedData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_), [LinkContainer.LinkRequestUpdating(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_LinkRequestUpdating_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.LinkRequestUpdate(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_LinkRequestUpdate_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.LinkRequestDestroying(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_LinkRequestDestroying_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.LinkRequestDestroy(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_LinkRequestDestroy_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.LinkAddedToDocument(object, AddToDocEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_LinkAddedToDocument_System_Object_VM_Managed_AddToDocEventArgs_), [LinkContainer.LinkRemovedFromDocument(object, RemoveFromDocEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_LinkRemovedFromDocument_System_Object_VM_Managed_RemoveFromDocEventArgs_), [LinkContainer.OnLinkReserved(ILink, object, EventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnLinkReserved_VM_Managed_ILink_System_Object_System_EventArgs_), [LinkContainer.CanBeDestroy(object)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_CanBeDestroy_System_Object_), [LinkContainer.DisposeManagedResources()](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_DisposeManagedResources), [LinkContainer.SetContainer(IOwned, bool)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_SetContainer_VM_Models_Pre_IOwned_System_Boolean_), [LinkContainer.OnChildUpdated(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnChildUpdated_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.OnContainerDestroy(object, LinkEventArgs)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnContainerDestroy_System_Object_VM_Managed_LinkEventArgs_), [LinkContainer.OnDeserialization(object)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnDeserialization_System_Object_), [LinkContainer.Verify(VerifiedResult)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_Verify_VM_Managed_VerifiedResult_), [LinkContainer.GetCopy(object)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_GetCopy_System_Object_), [LinkContainer.Dispose(bool)](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_Dispose_System_Boolean_), [LinkContainer.ClearChildInfoBeforeDeserialize](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_ClearChildInfoBeforeDeserialize), [LinkContainer.Container](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_Container), [LinkContainer.Owner](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_Owner), [LinkContainer.Document](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_Document), [LinkContainer.ID](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_ID), [LinkContainer.IsChildExternable](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_IsChildExternable), [LinkContainer.IsExternable](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_IsExternable), [LinkContainer.OnRemoved](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnRemoved), [LinkContainer.OnAdded](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnAdded), [LinkContainer.OnDestroy](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnDestroy), [LinkContainer.OnDestroying](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnDestroying), [LinkContainer.OnUpdate](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnUpdate), [LinkContainer.OnUpdating](VM.Managed.LinkContainer.md#VM_Managed_LinkContainer_OnUpdating), [LinkableBase.OnDeserialization(object)](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/Pre/Data/VM.Models.Pre/Models/LinkableBase.cs), ObservableObject.Dispose(), ObservableObject.RaisePropertyChanged(string), ObservableObject.RaisePropertyChanged(string, object, object), ObservableObject.Dispose(bool), ObservableObject.DisposeManagedResources(), ObservableObject.DisposeUnmanagedResources(), ObservableObject.IsDisposed, ObservableObject.TryDisposing, ObservableObject.Disposed, ObservableObject.Disposing, ObservableObject.PropertyChanged #### Extension Methods [LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_) ## Constructors ### Document() Initializes a new instance of the class ```csharp protected Document() ``` ## Fields ### g\_OpenDocuments The list of open documents. ```csharp public static List g_OpenDocuments ``` #### Field Value List<string> ### m\_unit The kernal unit. ```csharp protected Unit m_unit ``` #### Field Value Unit ### m\_unitKernal ```csharp protected Unit m_unitKernal ``` #### Field Value Unit ## Properties ### Attributes Gets or sets the Attribute to collection. ```csharp public AttributeCollection Attributes { get; set; } ``` #### Property Value [AttributeCollection](VM.Managed.AttributeCollection.md) ### AutoSaved Gets the document's auto save state. ```csharp public bool AutoSaved { get; protected set; } ``` #### Property Value bool ### CanClose Gets a value indicating that whether document can close. ```csharp public abstract bool CanClose { get; } ``` #### Property Value bool ### ClearChildInfoBeforeDeserialize Gets a value indicating whether \[clear child info before deserialize\]. ```csharp protected override bool ClearChildInfoBeforeDeserialize { get; } ``` #### Property Value bool ### CloseAllDialogWhenCloseDoc Gets a value indicating that whether all dialog is closing when document is closed. ```csharp public bool CloseAllDialogWhenCloseDoc { get; set; } ``` #### Property Value bool ### DocumentName Gets or sets the document name. ```csharp public string DocumentName { get; set; } ``` #### Property Value string ### DocumentSessionOverride Gets the document session override. ```csharp public virtual SessionOverride DocumentSessionOverride { get; } ``` #### Property Value SessionOverride ### DoingClose Gets a value indicating that whether document is closing. ```csharp public virtual bool DoingClose { get; set; } ``` #### Property Value bool ### DoingOpen Gets or sets a value indicating whether this instance is loading. ```csharp public virtual bool DoingOpen { get; set; } ``` #### Property Value bool ### ExpressionParser ```csharp public virtual ExpressionParser ExpressionParser { get; } ``` #### Property Value ExpressionParser ### FilePath Gets or sets the document file path. ```csharp public virtual string FilePath { get; set; } ``` #### Property Value string ### FilterdTypes ```csharp public List FilterdTypes { get; set; } ``` #### Property Value List<int> ### InitialConvertFactor Gets the initialized convert factor. ```csharp public virtual Unit.ConvertFactor InitialConvertFactor { get; } ``` #### Property Value Unit.ConvertFactor ### IsChildExternable Gets a value indicating whether this instance's child is externable. ```csharp public override bool IsChildExternable { get; } ``` #### Property Value bool ### IsExternable Gets a value indicating whether this instance is externable. ```csharp public override bool IsExternable { get; } ``` #### Property Value bool ### IsHideEntityListWindow ```csharp public bool IsHideEntityListWindow { get; set; } ``` #### Property Value bool ### IsHideFilterWindow ```csharp public bool IsHideFilterWindow { get; set; } ``` #### Property Value bool ### IsReplaced Gets or sets the replaced document flag. ```csharp public bool IsReplaced { get; set; } ``` #### Property Value bool ### KeepOldKernelUnit Keep old kernel unit during convert ACIS to Parasolid ```csharp protected virtual bool KeepOldKernelUnit { get; } ``` #### Property Value bool ### Modified Gets or sets the document's modify state. ```csharp public abstract bool Modified { get; set; } ``` #### Property Value bool ### SelectedLayoutAlgorithmType ```csharp public int SelectedLayoutAlgorithmType { get; set; } ``` #### Property Value int ## Methods ### ActiveChangedDoc() Active document. ```csharp public static void ActiveChangedDoc() ``` ### ActiveChangedView() Active view. ```csharp public static void ActiveChangedView() ``` ### Add(ObjectBase) Add object to document. ```csharp public abstract void Add(ObjectBase obj) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. ### AddItemToNavigaterForUndoRedo(ObjectBase) Add item to navigator for undo/redo. ```csharp public void AddItemToNavigaterForUndoRedo(ObjectBase obj) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. ### AddItemToSubEntityForUndoRedo(ObjectBase) Add item to subentity for undo/redo. ```csharp public void AddItemToSubEntityForUndoRedo(ObjectBase obj) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. ### AddReferenceForUndoRedo(ObjectBase) Add reference for undo/redo. ```csharp public void AddReferenceForUndoRedo(ObjectBase obj) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. ### AddToIDMap(IObject) add id to map ```csharp public virtual void AddToIDMap(IObject obj) ``` #### Parameters `obj` IObject The object. ### AddToSelectionList(ObjectBase) Add to selection list. ```csharp public virtual void AddToSelectionList(ObjectBase A_0) ``` #### Parameters `A_0` [ObjectBase](VM.Managed.ObjectBase.md) ### CancelSelection(bool, bool) Cancel selection. ```csharp public virtual void CancelSelection(bool A_0, bool A_1) ``` #### Parameters `A_0` bool `A_1` bool ### ClearDocument() Clears the document. ```csharp protected virtual void ClearDocument() ``` ### Close() ```csharp public void Close() ``` ### CloseView(View) Close view. ```csharp public virtual void CloseView(View view) ``` #### Parameters `view` [View](VM.Managed.View.md) The view. ### ContainsNameAttribute(string) Contains the name attribute. ```csharp public bool ContainsNameAttribute(string strNameAttribute) ``` #### Parameters `strNameAttribute` string The name value. #### Returns bool ### CreateView(UIntPtr) Create view. ```csharp public abstract View CreateView(UIntPtr hWnd) ``` #### Parameters `hWnd` UIntPtr The view handle. #### Returns [View](VM.Managed.View.md) ### DisplayModeShape(int, double) Display mode shape with scale factor. ```csharp public virtual void DisplayModeShape(int A_0, double A_1) ``` #### Parameters `A_0` int `A_1` double ### Dispose(bool) ```csharp [HandleProcessCorruptedStateExceptions] protected override void Dispose(bool A_0) ``` #### Parameters `A_0` bool ### EnableModeShape(bool) Disable the mode shape displaying. ```csharp public virtual void EnableModeShape(bool A_0) ``` #### Parameters `A_0` bool ### ExitCommandMode() Exit kernel command mode. ```csharp public virtual void ExitCommandMode() ``` ### FastToConvertUnitLength(bool) Fast convert unit length . ```csharp public virtual double FastToConvertUnitLength(bool bReverse) ``` #### Parameters `bReverse` bool The reverse state. #### Returns double ### ~Document() ```csharp protected ~Document() ``` ### FindObjectFromID(Identifier) FInd object form id. ```csharp public virtual IObject FindObjectFromID(Identifier id) ``` #### Parameters `id` Identifier The id. #### Returns IObject ### FindObjectFromKey(UIntPtr) Find object from key. ```csharp public virtual IObject FindObjectFromKey(UIntPtr key) ``` #### Parameters `key` UIntPtr The key. #### Returns IObject Find object ### GetChildren() ```csharp public virtual IEnumerable GetChildren() ``` #### Returns IEnumerable<IObject> ### GetCopyOfKernelUnit() Gets the document kernel unit from copy. ```csharp public virtual Unit GetCopyOfKernelUnit() ``` #### Returns Unit ### GetCopyOfUnit() Gets the document unit from copy. ```csharp public virtual Unit GetCopyOfUnit() ``` #### Returns Unit ### GetData(XmlNode) Gets the analysis document information data. ```csharp public virtual void GetData(XmlNode writer) ``` #### Parameters `writer` XmlNode The writer. ### GetDocumentFromOpenedDocument(string) Get document from already opened document. ```csharp public static Document GetDocumentFromOpenedDocument(string strFilePath) ``` #### Parameters `strFilePath` string The file path. #### Returns [Document](VM.Managed.Document.md) ### GetNextIdentifier() Gets the next object identifier. ```csharp public virtual Identifier GetNextIdentifier() ``` #### Returns Identifier ### GetUniqueNameAttribute(string) Gets the unique name attribute. ```csharp public string GetUniqueNameAttribute(string strNameAttribute) ``` #### Parameters `strNameAttribute` string The name value. #### Returns string ### Initialize(OpenDoc, BrowseFile, IsOpenDoc, GetDocFromOpenedDoc, ActiveDocChange, ActiveViewChange) Initialize delegate. ```csharp public static void Initialize(Document.OpenDoc delOpenDoc, Document.BrowseFile delBrowse, Document.IsOpenDoc delIsOpen, Document.GetDocFromOpenedDoc delOpenedDoc, Document.ActiveDocChange delActiveDocChange, Document.ActiveViewChange delActiveViewChange) ``` #### Parameters `delOpenDoc` [Document](VM.Managed.Document.md).[OpenDoc](VM.Managed.Document.OpenDoc.md) The OpenDoc delegate. `delBrowse` [Document](VM.Managed.Document.md).[BrowseFile](VM.Managed.Document.BrowseFile.md) The BrowseFile delegate. `delIsOpen` [Document](VM.Managed.Document.md).[IsOpenDoc](VM.Managed.Document.IsOpenDoc.md) The IsOpen delegate. `delOpenedDoc` [Document](VM.Managed.Document.md).[GetDocFromOpenedDoc](VM.Managed.Document.GetDocFromOpenedDoc.md) The OpenedDoc delegate. `delActiveDocChange` [Document](VM.Managed.Document.md).[ActiveDocChange](VM.Managed.Document.ActiveDocChange.md) The ActiveDocChange delegate. `delActiveViewChange` [Document](VM.Managed.Document.md).[ActiveViewChange](VM.Managed.Document.ActiveViewChange.md) The ActiveViewChange delegate. ### IsEnabledImpl(ObjectBase) Determines whether is enabled \[the specified object\] \[implementation\]. ```csharp abstract bool IsEnabledImpl(ObjectBase ob) ``` #### Parameters `ob` [ObjectBase](VM.Managed.ObjectBase.md) The object. #### Returns bool `true` if is enabled \[the specified object\]; otherwise, `false`. ### IsOpen(string) Whether document is open. ```csharp public static bool IsOpen(string strFilePath) ``` #### Parameters `strFilePath` string The file path. #### Returns bool ### IsTypeSupported(Type) Determines whether is \[supported type\] \[the specified type\]. ```csharp [Conditional("DEBUG")] public abstract void IsTypeSupported(Type type) ``` #### Parameters `type` Type The type. ### LinkRequestDestroy(object, LinkEventArgs) The destroy event occured from the linked object. ```csharp protected override void LinkRequestDestroy(object objNotifier, LinkEventArgs arg) ``` #### Parameters `objNotifier` object The linked object. `arg` [LinkEventArgs](VM.Managed.LinkEventArgs.md) The destroy event information. ### OnContainerDestroy(object, LinkEventArgs) Called when \[container destroy\]. ```csharp protected override void OnContainerDestroy(object obj, LinkEventArgs args) ``` #### Parameters `obj` object The object. `args` [LinkEventArgs](VM.Managed.LinkEventArgs.md) The instance containing the event data. ### OnDeserialization(object) Called when \[deserialization\]. ```csharp protected override void OnDeserialization(object obSender) ``` #### Parameters `obSender` object The sender. ### OnPostMakeDocument(DocCreateInfo) Called when \[post make document\] \[implementation\]. ```csharp protected virtual void OnPostMakeDocument(DocCreateInfo A_0) ``` #### Parameters `A_0` [DocCreateInfo](VM.Managed.DocCreateInfo.md) ### Open(string, bool, bool) Open document. ```csharp public static Document Open(string strFullFilePath, bool bActivate, bool bHidden) ``` #### Parameters `strFullFilePath` string The full file path. `bActivate` bool `bHidden` bool hidden file flag. #### Returns [Document](VM.Managed.Document.md) ### Open(string, bool) Open document. ```csharp public static Document Open(string strFullFilePath, bool bActivate) ``` #### Parameters `strFullFilePath` string The full file path. `bActivate` bool Whether document is acivate. #### Returns [Document](VM.Managed.Document.md) ### Open(string) Open document. ```csharp public static Document Open(string strFullFilePath) ``` #### Parameters `strFullFilePath` string The full file path. #### Returns [Document](VM.Managed.Document.md) ### Open(string, string, bool) Open document. ```csharp public static Document Open(string strRelativeFilePath, string strRefDir, bool bActivate) ``` #### Parameters `strRelativeFilePath` string The relative file path. `strRefDir` string The reference directory. `bActivate` bool Whether document is acivate. #### Returns [Document](VM.Managed.Document.md) ### Open(string, string) Open document. ```csharp public static Document Open(string strRelativeFilePath, string strRefDir) ``` #### Parameters `strRelativeFilePath` string The relative file path. `strRefDir` string The reference directory. #### Returns [Document](VM.Managed.Document.md) ### OperationBegin() Begin of operation. ```csharp public virtual void OperationBegin() ``` ### OperationEnd() End of operation. ```csharp public virtual void OperationEnd() ``` ### PostCloseDocument() Call when post \[close document\]. ```csharp public virtual void PostCloseDocument() ``` ### PostOpenDocument() Call when post \[open document\]. ```csharp public virtual void PostOpenDocument() ``` ### PostOpenDocumentAfterErrCheckEvent() Posts the open document after err check event. ```csharp public virtual void PostOpenDocumentAfterErrCheckEvent() ``` ### PostOpenDocumentAfterHookEvent() Call when post \[open document\] after hook event. ```csharp public virtual void PostOpenDocumentAfterHookEvent() ``` ### PostOpenDocumentAfterRestoreObjectID() Posts the open document after restore object id. ```csharp public virtual void PostOpenDocumentAfterRestoreObjectID() ``` ### PostOpenDocumentAfterSetFilePath() Call when post \[open document\] after set file path. ```csharp public virtual void PostOpenDocumentAfterSetFilePath() ``` ### PostOpenDocumentAndInitLayer() Call \[Open Document\] for initialize layer. ```csharp public virtual void PostOpenDocumentAndInitLayer() ``` ### PostSave(List<Document>, bool) ```csharp public virtual void PostSave(List lstOpenDocs, bool bModified) ``` #### Parameters `lstOpenDocs` List<[Document](VM.Managed.Document.md)> `bModified` bool ### RefreshReferenceForUndoRedo(ObjectBase) Refresh reference for undo/redo. ```csharp public void RefreshReferenceForUndoRedo(ObjectBase obj) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. ### RegisterAddon() Register addon ```csharp protected virtual void RegisterAddon() ``` ### RemoveFromIDMap(IObject) remove id from map ```csharp public void RemoveFromIDMap(IObject obj) ``` #### Parameters `obj` IObject The object. ### RemoveItemFromNavigaterForUndoRedo(ObjectBase) Remove item from navigator for undo/redo. ```csharp public void RemoveItemFromNavigaterForUndoRedo(ObjectBase obj) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. ### RenameItemFromNavigaterForUndoRedo(ObjectBase) Rename item from navigator for undo/redo. ```csharp public void RenameItemFromNavigaterForUndoRedo(ObjectBase obj) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. ### ReplacesNameAttribute(string, string) Replaces the name attribute. ```csharp public bool ReplacesNameAttribute(string strNameAttributeOld, string strNameAttributeNew) ``` #### Parameters `strNameAttributeOld` string The old name value. `strNameAttributeNew` string The new name value. #### Returns bool ### Save(string) Save document. ```csharp public abstract void Save(string strPath) ``` #### Parameters `strPath` string The path to save. ### SetData(XmlNode) Sets the analysis document information data. ```csharp public virtual void SetData(XmlNode reader) ``` #### Parameters `reader` XmlNode The reader. ### SetEnableImpl(ObjectBase, bool) Sets the enable \[implementation\]. ```csharp abstract void SetEnableImpl(ObjectBase ob, bool bEnable) ``` #### Parameters `ob` [ObjectBase](VM.Managed.ObjectBase.md) The object. `bEnable` bool if set to `true` enable. ### SetKernelUnit(string) Sets the kernel unit with length. ```csharp protected virtual void SetKernelUnit(string strLength) ``` #### Parameters `strLength` string The length unit. ### SetUnit(Unit) Sets the document unit. ```csharp protected virtual void SetUnit(Unit unit) ``` #### Parameters `unit` Unit The document unit. ### TryOpen(string, LoadSerializeContext, bool) Try opening document. ```csharp public static Document TryOpen(string strRelativeFilePath, LoadSerializeContext context, bool bActivate) ``` #### Parameters `strRelativeFilePath` string The relative file path. `context` LoadSerializeContext The context info. `bActivate` bool Whether document is acivate. #### Returns [Document](VM.Managed.Document.md) ### TryOpen(string, string, bool) Try opening document. ```csharp public static Document TryOpen(string strRelativeFilePath, string strRefDir, bool bActivate) ``` #### Parameters `strRelativeFilePath` string The relative file path. `strRefDir` string The reference directory. `bActivate` bool Whether document is acivate. #### Returns [Document](VM.Managed.Document.md) ### TryOpen(string, string) Try opening document. ```csharp public static Document TryOpen(string strRelativeFilePath, string strRefDir) ``` #### Parameters `strRelativeFilePath` string The relative file path. `strRefDir` string The reference directory. #### Returns [Document](VM.Managed.Document.md) ### UpdateAllItemInNavigaterForUndoRedo() Update all item in navigator for undo/redo. ```csharp public void UpdateAllItemInNavigaterForUndoRedo() ``` ### UpdateEnable(ObjectBase, bool) Update object to enable or disable. ```csharp public abstract void UpdateEnable(ObjectBase obj, bool bEnabled) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. `bEnabled` bool Whether object is enable. ### UpdateInterface(ObjectBase, bool) Update interface. ```csharp public virtual void UpdateInterface(ObjectBase obj, bool bInterfaced) ``` #### Parameters `obj` [ObjectBase](VM.Managed.ObjectBase.md) The object. `bInterfaced` bool Whether object is interfaced. ### UpdateItemInNavigaterForUndoRedo(IObjectBase) Update item in navigator for undo/redo. ```csharp public void UpdateItemInNavigaterForUndoRedo(IObjectBase obj) ``` #### Parameters `obj` IObjectBase The object. ### UpdateSimulationConfigurationForUndoRedo() Update simulation configuration for undo/redo. ```csharp public void UpdateSimulationConfigurationForUndoRedo() ``` ### WriteIDInformation() write id information ```csharp public string WriteIDInformation() ``` #### Returns string ### raise\_ChildAdded(object, Identifier) ```csharp protected virtual void raise_ChildAdded(object value0, Identifier value1) ``` #### Parameters `value0` object `value1` Identifier ### raise\_ChildRemoved(object, Identifier) ```csharp protected virtual void raise_ChildRemoved(object value0, Identifier value1) ``` #### Parameters `value0` object `value1` Identifier ### raise\_ChildReplaced(object, Identifier) ```csharp protected virtual void raise_ChildReplaced(object value0, Identifier value1) ``` #### Parameters `value0` object `value1` Identifier ### raise\_ChildReplacing(object, Identifier) ```csharp protected virtual void raise_ChildReplacing(object value0, Identifier value1) ``` #### Parameters `value0` object `value1` Identifier ### raise\_Destroying(object, EventArgs) ```csharp protected virtual void raise_Destroying(object value0, EventArgs value1) ``` #### Parameters `value0` object `value1` EventArgs ### raise\_OnChangeIconForNodalModal(object, DocumentEventArgs) ```csharp public void raise_OnChangeIconForNodalModal(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildAdded(object, DocumentEventArgs) ```csharp public void raise_OnChildAdded(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildDocNameUpdated(object, DocumentEventArgs) ```csharp public void raise_OnChildDocNameUpdated(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildMultiAdded(object, DocumentEventArgs) ```csharp public void raise_OnChildMultiAdded(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildRemoved(object, DocumentEventArgs) ```csharp public void raise_OnChildRemoved(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildRenamed(object, DocumentEventArgs) ```csharp public void raise_OnChildRenamed(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildRootSelect(object, DocumentEventArgs) ```csharp public void raise_OnChildRootSelect(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildUpdated(object, DocumentEventArgs) ```csharp public void raise_OnChildUpdated(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildUpdatedAll(object, DocumentEventArgs) ```csharp public void raise_OnChildUpdatedAll(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnChildUpdatedEnable(object, DocumentEventArgs) ```csharp public void raise_OnChildUpdatedEnable(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnClearSelectNavigator(object, DocumentEventArgs) ```csharp public void raise_OnClearSelectNavigator(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnDependentDocumentAdded(object, DependentDocEventArgs) ```csharp public void raise_OnDependentDocumentAdded(object objNotifier, DependentDocEventArgs args) ``` #### Parameters `objNotifier` object `args` [DependentDocEventArgs](VM.Managed.DependentDocEventArgs.md) ### raise\_OnDependentDocumentRemoved(object, DependentDocEventArgs) ```csharp public void raise_OnDependentDocumentRemoved(object objNotifier, DependentDocEventArgs args) ``` #### Parameters `objNotifier` object `args` [DependentDocEventArgs](VM.Managed.DependentDocEventArgs.md) ### raise\_OnDoingImport(object, DocumentEventArgs) ```csharp public void raise_OnDoingImport(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnSimulationCaseUpdated(object, EventArgs) ```csharp public void raise_OnSimulationCaseUpdated(object objNotifier, EventArgs args) ``` #### Parameters `objNotifier` object `args` EventArgs ### raise\_OnSingleObjectSelected(object, ObjectBaseEventArgs) ```csharp protected void raise_OnSingleObjectSelected(object value0, ObjectBaseEventArgs value1) ``` #### Parameters `value0` object `value1` [ObjectBaseEventArgs](VM.Managed.ObjectBaseEventArgs.md) ### raise\_OnSkipChildAdded(object, DocumentEventArgs) ```csharp public void raise_OnSkipChildAdded(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnSubentityAdded(object, DocumentEventArgs) ```csharp public void raise_OnSubentityAdded(object objNotifier, DocumentEventArgs args) ``` #### Parameters `objNotifier` object `args` [DocumentEventArgs](VM.Managed.DocumentEventArgs.md) ### raise\_OnSubentityRefreshed(object, EventArgs) ```csharp public void raise_OnSubentityRefreshed(object objNotifier, EventArgs args) ``` #### Parameters `objNotifier` object `args` EventArgs ### raise\_SelectionChanged(object, IEnumerable<Identifier>) ```csharp protected virtual void raise_SelectionChanged(object value0, IEnumerable value1) ``` #### Parameters `value0` object `value1` IEnumerable<Identifier> ### ChildAdded Occurs when \[on added child\]. ```csharp public virtual event EventHandler ChildAdded ``` #### Event Type EventHandler<Identifier> ### ChildRemoved Occurs when \[on removed child\]. ```csharp public virtual event EventHandler ChildRemoved ``` #### Event Type EventHandler<Identifier> ### ChildReplaced Occurs when \[on replaced child\]. ```csharp public virtual event EventHandler ChildReplaced ``` #### Event Type EventHandler<Identifier> ### ChildReplacing Occurs when \[on replacing child\]. ```csharp public virtual event EventHandler ChildReplacing ``` #### Event Type EventHandler<Identifier> ### Destroying Occurs when \[on destroying child\]. ```csharp public virtual event EventHandler Destroying ``` #### Event Type EventHandler ### OnChangeIconForNodalModal Occurs when \[on clear selected navigator item\]. ```csharp public event EventHandler OnChangeIconForNodalModal ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildAdded Occurs when \[on added child\]. ```csharp public event EventHandler OnChildAdded ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildDocNameUpdated Occurs when \[on updated child's document name\]. ```csharp public event EventHandler OnChildDocNameUpdated ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildMultiAdded Occurs when \[on multi added child\]. ```csharp public event EventHandler OnChildMultiAdded ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildRemoved Occurs when \[on removed child\]. ```csharp public event EventHandler OnChildRemoved ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildRenamed Occurs when \[on renamed child\]. ```csharp public event EventHandler OnChildRenamed ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildRootSelect Occurs when \[on child root select\]. ```csharp public event EventHandler OnChildRootSelect ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildUpdated Occurs when \[on updated child\]. ```csharp public event EventHandler OnChildUpdated ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildUpdatedAll Occurs when \[on updated child's everything\]. ```csharp public event EventHandler OnChildUpdatedAll ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnChildUpdatedEnable Occurs when \[on updated child's enablement\]. ```csharp public event EventHandler OnChildUpdatedEnable ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnClearSelectNavigator Occurs when \[on clear selected navigator item\]. ```csharp public event EventHandler OnClearSelectNavigator ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnDependentDocumentAdded Occurs when \[on added dependent document\]. ```csharp public event EventHandler OnDependentDocumentAdded ``` #### Event Type EventHandler<[DependentDocEventArgs](VM.Managed.DependentDocEventArgs.md)> ### OnDependentDocumentRemoved Occurs when \[on removed dependent document\]. ```csharp public event EventHandler OnDependentDocumentRemoved ``` #### Event Type EventHandler<[DependentDocEventArgs](VM.Managed.DependentDocEventArgs.md)> ### OnDoingImport Occurs when \[on doing import\]. ```csharp public event EventHandler OnDoingImport ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnSimulationCaseUpdated Occurs when \[on simulation case updated\]. ```csharp public event EventHandler OnSimulationCaseUpdated ``` #### Event Type EventHandler<EventArgs> ### OnSingleObjectSelected ```csharp public event EventHandler OnSingleObjectSelected ``` #### Event Type EventHandler<[ObjectBaseEventArgs](VM.Managed.ObjectBaseEventArgs.md)> ### OnSkipChildAdded Occurs when \[on skip to add child\]. ```csharp public event EventHandler OnSkipChildAdded ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnSubentityAdded Occurs when \[on subentity added\]. ```csharp public event EventHandler OnSubentityAdded ``` #### Event Type EventHandler<[DocumentEventArgs](VM.Managed.DocumentEventArgs.md)> ### OnSubentityRefreshed Occurs when \[on subentity refreshed\]. ```csharp public event EventHandler OnSubentityRefreshed ``` #### Event Type EventHandler<EventArgs> ### SelectionChanged Occurs when \[on child selection changed\]. ```csharp public virtual event EventHandler> SelectionChanged ``` #### Event Type EventHandler<IEnumerable<Identifier>>