Skip to main content

Motion Standalone Preprocessor C# library 2025 R2

Class ControlDocument

Last update: 16.07.2025

Namespace: VM.Managed
Assembly: VMAppCore.dll

This class is to represent the control document.

public class ControlDocument : Document, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IEnableManager, IRelatedDocument, IHistorySupport, IControlDocument

Inheritance

object ← ObservableObject ← LinkableBase ← LinkContainerContainerDocumentControlDocument

Implements

IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IEnableManager, IRelatedDocument, IHistorySupport, IControlDocument

Inherited Members

Document.g_OpenDocuments, Document.m_unit, Document.m_unitKernal, Document.raise_OnChildAdded(object, DocumentEventArgs), Document.raise_OnChildRemoved(object, DocumentEventArgs), Document.raise_OnChildRenamed(object, DocumentEventArgs), Document.raise_OnChildUpdated(object, DocumentEventArgs), Document.raise_OnChildUpdatedEnable(object, DocumentEventArgs), Document.raise_OnChildUpdatedAll(object, DocumentEventArgs), Document.raise_OnChildDocNameUpdated(object, DocumentEventArgs), Document.raise_OnDependentDocumentAdded(object, DependentDocEventArgs), Document.raise_OnDependentDocumentRemoved(object, DependentDocEventArgs), Document.raise_OnClearSelectNavigator(object, DocumentEventArgs), Document.raise_OnChildRootSelect(object, DocumentEventArgs), Document.raise_OnChangeIconForNodalModal(object, DocumentEventArgs), Document.raise_OnDoingImport(object, DocumentEventArgs), Document.raise_OnSkipChildAdded(object, DocumentEventArgs), Document.raise_OnSimulationCaseUpdated(object, EventArgs), Document.raise_OnSubentityRefreshed(object, EventArgs), Document.raise_OnSubentityAdded(object, DocumentEventArgs), Document.raise_OnChildMultiAdded(object, DocumentEventArgs), Document.raise_OnSingleObjectSelected(object, ObjectBaseEventArgs), Document.raise_Destroying(object, EventArgs), Document.raise_ChildAdded(object, Identifier), Document.raise_ChildRemoved(object, Identifier), Document.raise_ChildReplacing(object, Identifier), Document.raise_ChildReplaced(object, Identifier), Document.raise_SelectionChanged(object, IEnumerable), Document.Initialize(Document.OpenDoc, Document.BrowseFile, Document.IsOpenDoc, Document.GetDocFromOpenedDoc, Document.ActiveDocChange, Document.ActiveViewChange), Document.Open(string, bool, bool), Document.Open(string, bool), Document.Open(string), Document.Open(string, string, bool), Document.Open(string, string), Document.TryOpen(string, LoadSerializeContext, bool), Document.TryOpen(string, string, bool), Document.TryOpen(string, string), Document.GetDocumentFromOpenedDocument(string), Document.IsOpen(string), Document.ActiveChangedDoc(), Document.ActiveChangedView(), Document.Save(string), Document.PostSave(List, bool), Document.CreateView(UIntPtr), Document.CloseView(View), Document.Add(ObjectBase), Document.UpdateEnable(ObjectBase, bool), Document.UpdateInterface(ObjectBase, bool), Document.IsTypeSupported(Type), Document.AddToSelectionList(ObjectBase), Document.CancelSelection(bool, bool), Document.ExitCommandMode(), Document.PostOpenDocument(), Document.PostOpenDocumentAfterHookEvent(), Document.PostOpenDocumentAfterErrCheckEvent(), Document.PostOpenDocumentAfterRestoreObjectID(), Document.PostOpenDocumentAfterSetFilePath(), Document.PostCloseDocument(), Document.LinkRequestDestroy(object, LinkEventArgs), Document.PostOpenDocumentAndInitLayer(), Document.DisplayModeShape(int, double), Document.EnableModeShape(bool), Document.GetData(XmlNode), Document.SetData(XmlNode), Document.OperationBegin(), Document.OperationEnd(), Document.GetCopyOfUnit(), Document.GetCopyOfKernelUnit(), Document.FastToConvertUnitLength(bool), Document.ContainsNameAttribute(string), Document.ReplacesNameAttribute(string, string), Document.GetUniqueNameAttribute(string), Document.UpdateItemInNavigaterForUndoRedo(IObjectBase), Document.AddItemToNavigaterForUndoRedo(ObjectBase), Document.RemoveItemFromNavigaterForUndoRedo(ObjectBase), Document.RenameItemFromNavigaterForUndoRedo(ObjectBase), Document.UpdateAllItemInNavigaterForUndoRedo(), Document.UpdateSimulationConfigurationForUndoRedo(), Document.AddItemToSubEntityForUndoRedo(ObjectBase), Document.AddReferenceForUndoRedo(ObjectBase), Document.RefreshReferenceForUndoRedo(ObjectBase), Document.AddToIDMap(IObject), Document.FindObjectFromID(Identifier), Document.FindObjectFromKey(UIntPtr), Document.RemoveFromIDMap(IObject), Document.WriteIDInformation(), Document.GetNextIdentifier(), Document.GetChildren(), Document.Close(), Document.SetUnit(Unit), Document.SetKernelUnit(string), Document.IsEnabledImpl(ObjectBase), Document.SetEnableImpl(ObjectBase, bool), Document.OnDeserialization(object), Document.OnPostMakeDocument(DocCreateInfo), Document.RegisterAddon(), Document.OnContainerDestroy(object, LinkEventArgs), Document.ClearDocument(), Document.Dispose(bool), Document.KeepOldKernelUnit, Document.ClearChildInfoBeforeDeserialize, Document.ExpressionParser, Document.IsHideEntityListWindow, Document.IsHideFilterWindow, Document.SelectedLayoutAlgorithmType, Document.FilterdTypes, Document.CloseAllDialogWhenCloseDoc, Document.DoingOpen, Document.DoingClose, Document.Attributes, Document.AutoSaved, Document.IsChildExternable, Document.IsExternable, Document.IsReplaced, Document.FilePath, Document.DocumentName, Document.InitialConvertFactor, Document.DocumentSessionOverride, Document.CanClose, Document.Modified, Document.SelectionChanged, Document.ChildReplaced, Document.ChildReplacing, Document.ChildRemoved, Document.ChildAdded, Document.Destroying, Document.OnSingleObjectSelected, Document.OnChildMultiAdded, Document.OnSubentityAdded, Document.OnSubentityRefreshed, Document.OnSimulationCaseUpdated, Document.OnSkipChildAdded, Document.OnDoingImport, Document.OnChangeIconForNodalModal, Document.OnChildRootSelect, Document.OnClearSelectNavigator, Document.OnDependentDocumentRemoved, Document.OnDependentDocumentAdded, Document.OnChildDocNameUpdated, Document.OnChildUpdatedAll, Document.OnChildUpdatedEnable, Document.OnChildUpdated, Document.OnChildRenamed, Document.OnChildRemoved, Document.OnChildAdded, Container.Find(string), Container.FindLocal(string), Container.GetUnnamedObjectName(object), Container.GetNewEntityName(string, bool, int, int), Container.GetNewEntityName(string, bool, int), Container.GetNewEntityName(string), LinkContainer.SetModified(), LinkContainer.raise_OnUpdating(object, LinkEventArgs), LinkContainer.raise_OnUpdate(object, LinkEventArgs), LinkContainer.raise_OnDestroying(object, LinkEventArgs), LinkContainer.raise_OnDestroy(object, LinkEventArgs), LinkContainer.raise_OnAdded(object, AddToDocEventArgs), LinkContainer.raise_OnRemoved(object, RemoveFromDocEventArgs), LinkContainer.GetTargetListForUpdate(), LinkContainer.SkipUpdateObjectImpl(), LinkContainer.Initialize(Unit.ConvertFactor), LinkContainer.SetFlagWhenXMLFile(string, bool), LinkContainer.IsSerializableEvent(Delegate), LinkContainer.CustomGetObjectData(SerializationInfo, StreamingContext), LinkContainer.GetSerializedData(SerializationInfo, StreamingContext), LinkContainer.LinkRequestUpdating(object, LinkEventArgs), LinkContainer.LinkRequestUpdate(object, LinkEventArgs), LinkContainer.LinkRequestDestroying(object, LinkEventArgs), LinkContainer.LinkRequestDestroy(object, LinkEventArgs), LinkContainer.LinkAddedToDocument(object, AddToDocEventArgs), LinkContainer.LinkRemovedFromDocument(object, RemoveFromDocEventArgs), LinkContainer.OnLinkReserved(ILink, object, EventArgs), LinkContainer.CanBeDestroy(object), LinkContainer.DisposeManagedResources(), LinkContainer.SetContainer(IOwned, bool), LinkContainer.OnChildUpdated(object, LinkEventArgs), LinkContainer.OnContainerDestroy(object, LinkEventArgs), LinkContainer.OnDeserialization(object), LinkContainer.Verify(VerifiedResult), LinkContainer.GetCopy(object), LinkContainer.Dispose(bool), LinkContainer.ClearChildInfoBeforeDeserialize, LinkContainer.Container, LinkContainer.Owner, LinkContainer.Document, LinkContainer.ID, LinkContainer.IsChildExternable, LinkContainer.IsExternable, LinkContainer.OnRemoved, LinkContainer.OnAdded, LinkContainer.OnDestroy, LinkContainer.OnDestroying, LinkContainer.OnUpdate, LinkContainer.OnUpdating, LinkableBase.OnDeserialization(object), 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), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Constructors

ControlDocument()

public ControlDocument()

Properties

CanClose

Gets a value indicating that whether document can close.

public override bool CanClose { get; }

Property Value

bool

IsPropertySupport

public virtual bool IsPropertySupport { get; }

Property Value

bool

IsReload

public virtual bool IsReload { get; }

Property Value

bool

Modified

Gets or sets the document's modify state.

public override bool Modified { get; set; }

Property Value

bool

Methods

Add(ObjectBase)

Add object to document.

public override sealed void Add(ObjectBase A_0)

Parameters

A_0 ObjectBase

CreateView(UIntPtr)

Create view.

public override View CreateView(UIntPtr hWnd)

Parameters

hWnd UIntPtr

The view handle.

Returns

View

FindLocal(string)

Find DAFUL object from the container by name.

public override IObjectBase FindLocal(string A_0)

Parameters

A_0 string

Returns

IObjectBase

The DAFUL object.

IsEnabledImpl(ObjectBase)

Determines whether is enabled [the specified object] [implementation].

public override bool IsEnabledImpl(ObjectBase A_0)

Parameters

A_0 ObjectBase

Returns

bool

true if is enabled [the specified object]; otherwise, false.

IsTypeSupported(Type)

Determines whether is [supported type] [the specified type].

public override void IsTypeSupported(Type A_0)

Parameters

A_0 Type

Load(string)

public virtual void Load(string strPath)

Parameters

strPath string

OnPostMakeDocument(DocCreateInfo)

Called when [post make document] [implementation].

protected override void OnPostMakeDocument(DocCreateInfo info)

Parameters

info DocCreateInfo

Save(string)

Save document.

public override void Save(string strPath)

Parameters

strPath string

The path to save.

SetEnableImpl(ObjectBase, bool)

Sets the enable [implementation].

public override void SetEnableImpl(ObjectBase A_0, bool A_1)

Parameters

A_0 ObjectBase

A_1 bool

SetUnit(Unit)

Sets the document unit.

protected override void SetUnit(Unit A_0)

Parameters

A_0 Unit

TriggerPostMakeDocument(ControlDocCreateInfo)

public void TriggerPostMakeDocument(ControlDocCreateInfo info)

Parameters

info ControlDocCreateInfo

UpdateEnable(ObjectBase, bool)

Update object to enable or disable.

public override void UpdateEnable(ObjectBase A_0, bool A_1)

Parameters

A_0 ObjectBase

A_1 bool

Connect with Ansys