Skip to main content

Motion Standalone Preprocessor C# library 2025 R1

Class Document3D

Last update: 16.07.2025

Namespace: VM.Managed
Assembly: VMAppCore.dll

This class is to represent the 3D document.

public abstract class Document3D : HandledDocument, IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner, ITreatValidObject

Inheritance

object ← ObservableObject ← LinkableBase ← LinkContainerContainerDocumentHandledDocumentDocument3D

Implements

IObservableObject, IDisposableObject, ILinkable, ILinkContainerEvent, IVerifiable, IEnableManager, IRelatedDocument, IHistorySupport, ITemplateDocument, IDocument3D, IHandledDocument, IDocument, IObject, IEventProvider, IContainer, ILinkContainer, IOwned, IHasID, IDocumentOwner, ITreatValidObject

Inherited Members

HandledDocument.AddToSelectionList(ObjectBase), HandledDocument.CancelSelection(bool, bool), HandledDocument.ExitCommandMode(), HandledDocument.CancelSelectedFaceset(bool), HandledDocument.SetHandle(UIntPtr), HandledDocument.OnDeserialization(object), HandledDocument.FromHandle(UIntPtr), HandledDocument.PostOpenDocument(), HandledDocument.Dispose(bool), HandledDocument.DoNotCheckHandleWhenCreate, HandledDocument.Handle, 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.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

Document3D(UIntPtr)

Initializes a new instance of the class

public Document3D(UIntPtr pDoc)

Parameters

pDoc UIntPtr

Fields

RibbonGalleryIndex

The ribbon gallery index

public Document3D.GetRibbonGalleryIndex RibbonGalleryIndex

Field Value

Document3D.GetRibbonGalleryIndex

g_dRenderingType

public static enRenderType g_dRenderingType

Field Value

enRenderType

m_bReload

protected bool m_bReload

Field Value

bool

m_dicCategory

[Obsolete]
protected Dictionary<string linkcontainer.update>&gt;&gt; m_dicCategory

Field Value

Dictionarystring, LinkedListChildObjectBase, LinkContainer.Update&gt;&gt;&gt;

m_dicCategoryCollection

The category container.

protected Dictionary<string linkcontainer.update>&gt;&gt; m_dicCategoryCollection

Field Value

Dictionarystring, LinkLinkedListObjectBase, ChildObjectBase, LinkContainer.Update&gt;&gt;&gt;

m_lstAssem

The assembly container.

protected LinkListCollection<assembly linkcontainer.none>&gt; m_lstAssem

Field Value

LinkListCollectionAssembly, LinkAssembly, LinkContainer.None, LinkContainer.Update, LinkContainer.None&gt;&gt;

m_strVersion

protected string m_strVersion

Field Value

string

Properties

AssembledBodyList

Gets or sets the assembled body list.

public virtual ObjectBase[] AssembledBodyList { get; }

Property Value

ObjectBase[]

CanClose

Gets a value indicating that whether document can close.

public override bool CanClose { get; }

Property Value

bool

Categories

Gets the categorys.

public ICollection<string> Categories { get; }

Property Value

ICollectionstring&gt;

CategoryInfo

public static CategoryInfo CategoryInfo { get; }

Property Value

CategoryInfo

ChangeReference

Gets a value indicating that whether reference is changed.

protected bool ChangeReference { get; set; }

Property Value

bool

CommentOfDocument

Sets/Gets a comment of document. It has a character of seperator. The Character is ';'.

public string CommentOfDocument { get; set; }

Property Value

string

CountOfSelectionObject

Get count of selected object.

public int CountOfSelectionObject { get; }

Property Value

int

CountOfUnderCursorObject

Get count of Under-Cursor object.

public int CountOfUnderCursorObject { get; }

Property Value

int

CountOfUnderCursorPickableObject

Get count of Under-Cursor pickable object.

public int CountOfUnderCursorPickableObject { get; }

Property Value

int

CurrentBasicOp

Gets the type of current basic operation.

public Document3D.BasicOpType CurrentBasicOp { get; }

Property Value

Document3D.BasicOpType

CustomDesignParameterList

Gets or sets the custom design parameter list.

public virtual ObjectBase[] CustomDesignParameterList { get; }

Property Value

ObjectBase[]

CustomPerformanceIndexList

Gets or sets the custom performance index list.

public virtual ObjectBase[] CustomPerformanceIndexList { get; }

Property Value

ObjectBase[]

DoingCreateEntityOperation

Gets a value indicating that whether [create entity operation] is executing.

public bool DoingCreateEntityOperation { get; set; }

Property Value

bool

DoingTemplateBasedXml

Gets a value indicating that whether [Load TemplateBasedXml] is doing.

public bool DoingTemplateBasedXml { get; }

Property Value

bool

ExtensionName

Gets or sets the name of extension.

public string ExtensionName { get; set; }

Property Value

string

Format

Gets or sets the type of fileformat.

public Document3D.FileFormat Format { get; set; }

Property Value

Document3D.FileFormat

FromTemplate

Gets a value indicating whether [from template].

public bool FromTemplate { get; }

Property Value

bool

IconSize

Gets or sets the icon size.

public virtual double IconSize { get; set; }

Property Value

double

InitialCategories

Gets the initialize categories.

protected abstract List<string> InitialCategories { get; }

Property Value

Liststring&gt;

IsAdvancedMode

Gets or sets a value indicating whether this instance is advanced mode.

public bool IsAdvancedMode { get; set; }

Property Value

bool

IsPropertySupport

Gets a value indicating whether this instance is property support.

public virtual bool IsPropertySupport { get; }

Property Value

bool

LayerManager

Gets the layer manager.

public LayerManager LayerManager { get; }

Property Value

LayerManager

LoadingExceptions

Gets the exceptions that occurred when loading.

public List<exception> LoadingExceptions { get; }

Property Value

ListException&gt;

MessageWhenLoad

Gets or sets message when document load.

public string MessageWhenLoad { get; set; }

Property Value

string

Modified

Gets or sets the document's modify state.

public override bool Modified { get; set; }

Property Value

bool

NodalBodyList

Gets the nodal body list.

public virtual ObjectBase[] NodalBodyList { get; }

Property Value

ObjectBase[]

NodalOutputCandidateObjects

Get nodal output candidate.

public List<inodaloutputcandidate> NodalOutputCandidateObjects { get; }

Property Value

ListINodalOutputCandidate&gt;

SelectionObjects

Get selected object container.

public List<objectbase> SelectionObjects { get; }

Property Value

ListObjectBase&gt;

SkipUIUpdating

Gets or sets the document's skip ui updating state.

public bool SkipUIUpdating { get; set; }

Property Value

bool

SymmetricPlane

Gets or sets the symmetric plane.

public Plane SymmetricPlane { get; set; }

Property Value

Plane

TemplatePath

Gets or sets the template path.

public string TemplatePath { get; }

Property Value

string

ToolKitName

Gets or sets the name of toolkit.

public string ToolKitName { get; set; }

Property Value

string

UnderCursorObjects

Get selected object container.

public List<objectbase> UnderCursorObjects { get; }

Property Value

ListObjectBase&gt;

UnderCursorPickableObjects

Get pickable object container.

public List<objectbase> UnderCursorPickableObjects { get; }

Property Value

ListObjectBase&gt;

UseMultipleAddition

Gets or sets the multiple addition use flag.

public bool UseMultipleAddition { get; set; }

Property Value

bool

UseSymmetric

Gets or sets a value indicating whether use symmetric option.

public bool UseSymmetric { get; }

Property Value

bool

VersionInfo

Gets a version of document.

public string VersionInfo { get; }

Property Value

string

VisibleTarget

Gets or sets the visible target.

public virtual ObjectBase[] VisibleTarget { get; }

Property Value

ObjectBase[]

this[string]

public ICollection<objectbase> this[string strCategory] { get; }

Property Value

ICollectionObjectBase&gt;

Methods

Activate()

Activate document.

public void Activate()

ActivateDocument()

Activate document.

public void ActivateDocument()

ActiveCurveset(UIntPtr, bool)

Activate curveset.

public void ActiveCurveset(UIntPtr curveset_key, bool bActive)

Parameters

curveset_key UIntPtr

The edge key.

bActive bool

if set to true active.

ActiveFaceset(UIntPtr, bool)

Activate faceset.

public void ActiveFaceset(UIntPtr faceset_key, bool bActive)

Parameters

faceset_key UIntPtr

The facet key.

bActive bool

if set to true active.

ActiveObject(List)

public void ActiveObject(List<objectbase> lstObject)

Parameters

lstObject ListObjectBase&gt;

Add(ObjectBase, ObjectBase)

Add object to document.

public virtual void Add(ObjectBase objAdd, ObjectBase objExistAfter)

Parameters

objAdd ObjectBase

The object.

objExistAfter ObjectBase

The object that exist added object after.

Add(ObjectBase)

Add object to document.

public override void Add(ObjectBase obj)

Parameters

obj ObjectBase

The object.

AddAssembly(Assembly)

Add assembly to assembly container.

public void AddAssembly(Assembly assem)

Parameters

assem Assembly

The assembly.

AddInterface(string)

Add interface.

public void AddInterface(string strXml)

Parameters

strXml string

The interface information.

AddNewReference(ObjectBase[], string)

Add object for new reference.

public virtual void AddNewReference(ObjectBase[] arObj, string strCategory)

Parameters

arObj ObjectBase[]

The object array.

strCategory string

The category name.

AddNewReference(ObjectBase)

Add object for new reference.

public virtual void AddNewReference(ObjectBase ob)

Parameters

ob ObjectBase

The object.

ChangeKernelUnitWithScale(string)

change kernel unit.

public void ChangeKernelUnitWithScale(string strLength)

Parameters

strLength string

The length unit.

ChangeTopologyForVMPID()

public virtual void ChangeTopologyForVMPID()

CheckBeforeSave()

protected virtual void CheckBeforeSave()

CheckMassPropForCADImport()

Check mass property for CAD Import.

public virtual string CheckMassPropForCADImport()

Returns

string

The error message.

ChildAdd(ObjectBase, string)

Call OnChildAdded.

public void ChildAdd(ObjectBase obj, string strXml)

Parameters

obj ObjectBase

The object.

strXml string

The information.

ChildRemove(ObjectBase, string)

Call OnChildRemove.

public void ChildRemove(ObjectBase obj, string strXml)

Parameters

obj ObjectBase

The object.

strXml string

The information.

ChildRename(ObjectBase, string)

Call OnChildRename.

public void ChildRename(ObjectBase obj, string strXml)

Parameters

obj ObjectBase

The object.

strXml string

The information.

ChildUpdate(ObjectBase, string)

Call OnChildUpdate.

public void ChildUpdate(ObjectBase obj, string strXml)

Parameters

obj ObjectBase

The object.

strXml string

The information.

ClearAssembly()

Clear assembly.

public void ClearAssembly()

ClearDocument()

Clears the document.

protected override void ClearDocument()

ContainsEntityToEntityDictionary(ObjectBase)

Determines whether contains [entity to entity dictionary].

public bool ContainsEntityToEntityDictionary(ObjectBase obj)

Parameters

obj ObjectBase

The object.

Returns

bool

CreateAssembly()

Create assembly.

public Assembly CreateAssembly()

Returns

Assembly

CreateAssemblyImpl()

Creates the assembly [implementation].

protected abstract Assembly CreateAssemblyImpl()

Returns

Assembly

The assembly

CreateCanvas(bool)

Create canvas.

public Canvas CreateCanvas(bool bThreadSafeCanvas)

Parameters

bThreadSafeCanvas bool

if set to true thread safely canvas.

Returns

Canvas

The canvas.

CreateCanvas()

Create canvas.

public Canvas CreateCanvas()

Returns

Canvas

The canvas.

CreateView(UIntPtr)

Create view.

public override View CreateView(UIntPtr hWnd)

Parameters

hWnd UIntPtr

The view handle.

Returns

View

CreateViewCore(UIntPtr)

Create view [Core].

protected virtual View CreateViewCore(UIntPtr pView)

Parameters

pView UIntPtr

The view handle.

Returns

View

DecreaseReferedDocumentCount()

public void DecreaseReferedDocumentCount()

DeleteCore(List, List)

public void DeleteCore(List<objectbase> lstObjNew, List<destroyeventargs> lstArg)

Parameters

lstObjNew ListObjectBase&gt;

lstArg ListDestroyEventArgs&gt;

DeleteObjectBases(ref DestroyType, IEnumerable, bool)

public bool DeleteObjectBases(ref DestroyType typeDestroy, IEnumerable<objectbase> targetObjectBases, bool bNotUseDelMsg)

Parameters

typeDestroy DestroyType

targetObjectBases IEnumerableObjectBase&gt;

bNotUseDelMsg bool

Returns

bool

DeleteObjectBases(ref DestroyType, IEnumerable)

public bool DeleteObjectBases(ref DestroyType typeDestroy, IEnumerable<objectbase> targetObjectBases)

Parameters

typeDestroy DestroyType

targetObjectBases IEnumerableObjectBase&gt;

Returns

bool

DeleteWithSelectionObjects(ref DestroyType, bool)

Delete with Selection Objects.

public bool DeleteWithSelectionObjects(ref DestroyType typeDestroy, bool bNotUseDelMsg)

Parameters

typeDestroy DestroyType

The destroy type.

bNotUseDelMsg bool

Not use delete message

Returns

bool

DeleteWithSelectionObjects(ref DestroyType)

Delete with Selection Objects.

public bool DeleteWithSelectionObjects(ref DestroyType typeDestroy)

Parameters

typeDestroy DestroyType

The destroy type.

Returns

bool

DeleteWithSelectionObjects()

Delete with Selection Objects.

public virtual bool DeleteWithSelectionObjects()

Returns

bool

DisplayModeShape(int, double)

Display mode shape with scale factor.

public override void DisplayModeShape(int A_0, double A_1)

Parameters

A_0 int

A_1 double

Dispose(bool)

[HandleProcessCorruptedStateExceptions]
protected override void Dispose(bool A_0)

Parameters

A_0 bool

EnableModeShape(bool)

Disable the mode shape displaying.

public override void EnableModeShape(bool A_0)

Parameters

A_0 bool

EndCADImportLog()

Ends the CAD import log.

protected virtual void EndCADImportLog()

EraseAllDisplayObject()

protected void EraseAllDisplayObject()

ExistUnderCursor()

Whether object exists under cursor.

public bool ExistUnderCursor()

Returns

bool

true if object exists under cursor; otherwise, false.

ExportCADBody(string, List, string, string)

public virtual void ExportCADBody(string strFilePath, List<document3d> lstBodyInfo, string strCADConvert, string strOption)

Parameters

strFilePath string

lstBodyInfo ListDocument3D.ExportBodyInfo&gt;

strCADConvert string

strOption string

ExportCADBody(string, List, string)

public virtual void ExportCADBody(string strFilePath, List<document3d> lstBodyInfo, string strAcisVer)

Parameters

strFilePath string

lstBodyInfo ListDocument3D.ExportBodyInfo&gt;

strAcisVer string

ExportCADFile(string, string, string)

Export cad file.

public virtual void ExportCADFile(string strFilePath, string strCADConvert, string strOption)

Parameters

strFilePath string

The cad import file path.

strCADConvert string

The path of cad convert exe.

strOption string

The option.

~Document3D()

Releases unmanaged resources and performs other cleanup operations before the is reclaimed by garbage collection.

protected ~Document3D()

FindBodyFromCADBody(ObjectBase)

Finds the body from CAD body.

public virtual ObjectBase FindBodyFromCADBody(ObjectBase obj)

Parameters

obj ObjectBase

The CAD body.

Returns

ObjectBase

The body such as solid body, assembled body.

FindCategory(string)

Finds the category.

public abstract string FindCategory(string strType)

Parameters

strType string

The fullname of type.

Returns

string

The category name

FindCurveset(UIntPtr, bool)

Find curveset.

public UIntPtr FindCurveset(UIntPtr edge_key, bool bQuickSearch)

Parameters

edge_key UIntPtr

The edge key.

bQuickSearch bool

if set to true quick search.

Returns

UIntPtr

The edge handle.

FindFaceset(UIntPtr, bool)

Find faceset.

public UIntPtr FindFaceset(UIntPtr face_key, bool bQuickSearch)

Parameters

face_key UIntPtr

The facet key.

bQuickSearch bool

if set to true quick search.

Returns

UIntPtr

The facet handle.

FindLocal(string)

Find DAFUL object from the container by name.

public override IObjectBase FindLocal(string strName)

Parameters

strName string

The DAFUL object name.

Returns

IObjectBase

The DAFUL object.

FindObjectForSelection(ObjectBase, OperationTypeForSelection)

Finds the object for show property.

public virtual ObjectBase FindObjectForSelection(ObjectBase obj, Document3D.OperationTypeForSelection enType)

Parameters

obj ObjectBase

The obj.

enType Document3D.OperationTypeForSelection

The Operation Type for Selection

Returns

ObjectBase

GetAllArgumentList()

public virtual List<keyvaluepair><string string>&gt; GetAllArgumentList()

Returns

ListKeyValuePairstring, string&gt;&gt;

GetAssembly()

Get assembly container.

public Assembly[] GetAssembly()

Returns

Assembly[]

GetBodies(ref List)

protected virtual void GetBodies(ref List<objectbase> lstBody)

Parameters

lstBody ListObjectBase&gt;

GetBodyAndTransformation(ref List)

public virtual void GetBodyAndTransformation(ref List<document3d> A_0)

Parameters

A_0 ListDocument3D.ExportBodyInfo&gt;

GetCADBodyNameAttribute(ref List)

public virtual void GetCADBodyNameAttribute(ref List<string> lstName)

Parameters

lstName Liststring&gt;

GetCategoryChildren(string)

Gets the object category container from category name.

public virtual IEnumerable<iobjectbase> GetCategoryChildren(string categoryName)

Parameters

categoryName string

Returns

IEnumerable

The object category container.

GetCuttingPlane()

public bool GetCuttingPlane()

Returns

bool

GetData(XmlNode)

Gets the analysis document information data.

public override void GetData(XmlNode writer)

Parameters

writer XmlNode

The writer.

GetImportCADBody()

Gets the Import CAD Body.

public virtual List<objectbase> GetImportCADBody()

Returns

ListObjectBase&gt;

GetInfoFromDocumentPropertyGrid(XmlDocument, XmlDocument)

Gets the information from document property grid.

public virtual void GetInfoFromDocumentPropertyGrid(XmlDocument xmlTarget, XmlDocument xmlTool)

Parameters

xmlTarget XmlDocument

The target xml.

xmlTool XmlDocument

The tool xml.

GetNearestUnderCursorObject()

Get the nearest Under-Cursor object.

public ObjectBase GetNearestUnderCursorObject()

Returns

ObjectBase

The nearest Under-Cursor object.

GetOwnedDocuments(LinkedList)

Gets the owned documents.

virtual void GetOwnedDocuments(LinkedList<idocument> lstOwnedDoc)

Parameters

lstOwnedDoc LinkedList

GetReferDocument(ref List)

public virtual void GetReferDocument(ref List<document3d> lstDocument)

Parameters

lstDocument ListDocument3D&gt;

GetReferedDocumentCount()

public int GetReferedDocumentCount()

Returns

int

GetReference(ObjectBase, ref List, ref List)

public virtual void GetReference(ObjectBase obSub, ref List<reference> lstRef, ref List<objectbase> lstOther)

Parameters

obSub ObjectBase

lstRef ListReference&gt;

lstOther ListObjectBase&gt;

GetReplaceableInfo(BuilderImport[])

Gets the replaceable information.

protected List<body> GetReplaceableInfo(BuilderImport[] arBuilder)

Parameters

arBuilder BuilderImport[]

The builder object array.

Returns

ListBody.ReplaceCADInfo&gt;

The list of replaceable information.

GetUnnamedObjectName(object)

Get an unnamed object name.

public override string GetUnnamedObjectName(object obUnnamed)

Parameters

obUnnamed object

The unnamed object.

Returns

string

The unnamed object name.

HideObjectInReading()

Hide object in reading template.

protected virtual void HideObjectInReading()

ImportCADBody(BuilderImport[])

Imports the CAD body.

protected virtual void ImportCADBody(BuilderImport[] arOb)

Parameters

arOb BuilderImport[]

The build object array.

IncreaseReferedDocumentCount()

public void IncreaseReferedDocumentCount()

InitCategory()

Initialize category.

public void InitCategory()

InitializeKernelUnit()

Initialize kernel unit.

public void InitializeKernelUnit()

IsContainsCategoryName(string)

Determines whether is [contains category name] [the specified category name].

public bool IsContainsCategoryName(string strCategoryName)

Parameters

strCategoryName string

Name of the category.

Returns

bool

true if is [contains category name] [the specified category name]; otherwise, false.

IsCuttingPlaneSelected()

public bool IsCuttingPlaneSelected()

Returns

bool

IsMatchSelectObjectAndUnderCursorObject()

check match of select object and under cursor object.

public bool IsMatchSelectObjectAndUnderCursorObject()

Returns

bool

IsSelectFromUnderCursor(ulong)

Determines whether selected object.

public bool IsSelectFromUnderCursor(ulong keyObject)

Parameters

keyObject ulong

The object.

Returns

bool

true if already selected; otherwise, false.

IsTypeSupported(Type)

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

public override void IsTypeSupported(Type type)

Parameters

type Type

The type.

LinkRequestUpdate(object, LinkEventArgs)

The update event occured from the linked object.

protected override void LinkRequestUpdate(object obNotifier, LinkEventArgs arg)

Parameters

obNotifier object

arg LinkEventArgs

The update event information.

Load(XmlReader)

Load document [Not Implemented].

protected virtual void Load(XmlReader A_0)

Parameters

A_0 XmlReader

LoadCADFile(string, CadImportColorType, Color, CadImportResultType, CadImportUnitType, string)

Load cad import file.

public void LoadCADFile(string strPath, Document3D.CadImportColorType color_type, Color color, Document3D.CadImportResultType type, Document3D.CadImportUnitType typeUnit, string strCADConvert)

Parameters

strPath string

The cad import file path.

color_type Document3D.CadImportColorType

color Color

The cad import color.

type Document3D.CadImportResultType

The cad import result type.

typeUnit Document3D.CadImportUnitType

The cad import unit type.

strCADConvert string

The path of cad convert exe.

LoadCADFile(string, CadImportResultType, CadImportUnitType)

Load cad import file.

public void LoadCADFile(string strPath, Document3D.CadImportResultType type, Document3D.CadImportUnitType typeUnit)

Parameters

strPath string

The cad import file path.

type Document3D.CadImportResultType

The cad import result type.

typeUnit Document3D.CadImportUnitType

The cad import unit type.

LoadCADFile(string, Color, CadImportResultType)

Load cad import file.

public void LoadCADFile(string strPath, Color color, Document3D.CadImportResultType type)

Parameters

strPath string

The cad import file path.

color Color

The cad import color.

type Document3D.CadImportResultType

The cad import result type.

LoadCADFile(string, CadImportResultType, string)

Load cad import file.

public void LoadCADFile(string strPath, Document3D.CadImportResultType type, string strCADConvert)

Parameters

strPath string

The cad import file path.

type Document3D.CadImportResultType

The cad import result type.

strCADConvert string

The path of cad convert exe.

LoadCADFile(string, CadImportResultType)

Load cad import file.

public void LoadCADFile(string strPath, Document3D.CadImportResultType type)

Parameters

strPath string

The cad import file path.

type Document3D.CadImportResultType

The cad import result type.

LoadCategoryFiles(string)

Loads the category files.

public static void LoadCategoryFiles(string strCategoryDir)

Parameters

strCategoryDir string

The category directory.

LoadCategoryInfoFromFile(string, Dictionary, List)

protected static void LoadCategoryInfoFromFile(string strCategoryName, Dictionary<string string> dicTypeCategory, List<string> lstCategory)

Parameters

strCategoryName string

dicTypeCategory Dictionarystring, string&gt;

lstCategory Liststring&gt;

LoadTemplateBasedXml(XmlReader)

Loads the XML for template based document.

protected virtual void LoadTemplateBasedXml(XmlReader A_0)

Parameters

A_0 XmlReader

MakeXmlForDocumentPropertyGrid(XmlDocument, ref string)

Makes the XML for document property grid.

public virtual string MakeXmlForDocumentPropertyGrid(XmlDocument xmlDom, ref string strGroupName)

Parameters

xmlDom XmlDocument

The XML DOM.

strGroupName string

Name of the string group.

Returns

string

MappingEntity()

protected virtual void MappingEntity()

OnDeserialization(object)

Called when [deserialization].

protected override void OnDeserialization(object sender)

Parameters

sender object

The sender.

OnPostMakeDocument(DocCreateInfo)

Called when [post make document] [implementation].

protected override void OnPostMakeDocument(DocCreateInfo A_0)

Parameters

A_0 DocCreateInfo

OpenPropertyObjectBases(List)

public bool OpenPropertyObjectBases(List<objectbase> targetObjectBases)

Parameters

targetObjectBases ListObjectBase&gt;

Returns

bool

OpenPropertyWithFirstSelectionObject()

Open property dialog with Selection Objects.

public bool OpenPropertyWithFirstSelectionObject()

Returns

bool

OpenPropertyWithSelectionObjects()

Open property dialog with Selection Objects.

public bool OpenPropertyWithSelectionObjects()

Returns

bool

PostCloseDocument()

Call when post [close document].

public override void PostCloseDocument()

PostOpenDocument()

Call when post [open document].

public override void PostOpenDocument()

PostOpenDocumentAndInitLayer()

Call [Open Document] for initialize layer.

public override sealed void PostOpenDocumentAndInitLayer()

PostSave(List, bool)

public override void PostSave(List<document> lstOpenDocs, bool bModified)

Parameters

lstOpenDocs ListDocument&gt;

bModified bool

PreloadCADFile(string, CadImportColorType, Color, CadImportResultType, CadImportUnitType, string, ref BuilderImport[])

Preload cad import file.

public void PreloadCADFile(string strPath, Document3D.CadImportColorType color_type, Color color, Document3D.CadImportResultType type, Document3D.CadImportUnitType typeUnit, string strCADConvert, ref BuilderImport[] arBuilderInfo)

Parameters

strPath string

The cad import file path.

color_type Document3D.CadImportColorType

color Color

The cad import color.

type Document3D.CadImportResultType

The cad import result type.

typeUnit Document3D.CadImportUnitType

The cad import unit type.

strCADConvert string

The path of cad convert exe.

arBuilderInfo BuilderImport[]

The output builder information.

ReAssemblyCore()

Reassembly

protected virtual bool ReAssemblyCore()

Returns

bool

true if success; otherwise, false.

ReAssemblyImpl(ObjectBase)

Reassembly [implementation].

protected virtual bool ReAssemblyImpl(ObjectBase ob)

Parameters

ob ObjectBase

The object.

Returns

bool

true if success; otherwise, false.

ReInitInterfaceForAssembly()

Reinitialize interface for assembly.

public virtual void ReInitInterfaceForAssembly()

ReadCategoryXml(string, string, XmlReader)

Read objects in specialized category from xml reader.

protected void ReadCategoryXml(string strCategoryName, string strElementName, XmlReader reader)

Parameters

strCategoryName string

The category name.

strElementName string

The element name.

reader XmlReader

The reader.

RedrawCuttingPlane()

public void RedrawCuttingPlane()

RefreshAllViews()

Refresh all views.

public void RefreshAllViews()

RegisterCurveset(UIntPtr, UIntPtr, bool)

Register curveset.

public void RegisterCurveset(UIntPtr curveset_key, UIntPtr edge_key, bool bAdd)

Parameters

curveset_key UIntPtr

The curveset key.

edge_key UIntPtr

The edge key.

bAdd bool

if set to true add.

RegisterFaceset(UIntPtr, UIntPtr, bool)

Register faceset.

public void RegisterFaceset(UIntPtr faceset_key, UIntPtr face_key, bool bAdd)

Parameters

faceset_key UIntPtr

The facet key.

face_key UIntPtr

The face key.

bAdd bool

if set to true add.

RegisterLoadingException(Exception)

Registers the exception.

public void RegisterLoadingException(Exception exception)

Parameters

exception Exception

The exception.

RemoveAssembly(Assembly)

Remove assembly.

public void RemoveAssembly(Assembly assem)

Parameters

assem Assembly

The assembly.

RemoveEntityForReplace(ObjectBase)

Remove entity for replace.

public void RemoveEntityForReplace(ObjectBase obj)

Parameters

obj ObjectBase

The object.

RemoveInterface(string)

Remove interface.

public void RemoveInterface(string strXml)

Parameters

strXml string

The interface information.

RenameEntityImpl(string, ObjectBase)

Rename entity [Implementation].

protected virtual void RenameEntityImpl(string strOldName, ObjectBase namedObj)

Parameters

strOldName string

The old name.

namedObj ObjectBase

The new object.

RenameInterface(string)

Rename interface.

public void RenameInterface(string strXml)

Parameters

strXml string

The interface information.

Repair()

public void Repair()

RepairImpl()

Repair a document.

protected virtual void RepairImpl()

ReplaceCADBody(BuilderImport[])

Replaces the CAD body.

public virtual void ReplaceCADBody(BuilderImport[] arBuilder)

Parameters

arBuilder BuilderImport[]

The builder object array.

ResetFacesetSurfaceType()

public void ResetFacesetSurfaceType()

RunPredefinedOperation()

Run pre-defined operation.

public virtual void RunPredefinedOperation()

Save(XmlWriter)

Save document [Not Implemented].

protected virtual void Save(XmlWriter A_0)

Parameters

A_0 XmlWriter

Save(string)

Save document.

public override sealed void Save(string strPath)

Parameters

strPath string

The path to save.

Save(string, bool, Dictionary)

public void Save(string strPath, bool bAutoSave, Dictionary<string string> mapSubPath)

Parameters

strPath string

bAutoSave bool

mapSubPath Dictionarystring, string&gt;

Save(string, bool, bool)

save document.

public void Save(string strPath, bool bAutoSave, bool bUseBackUpFile)

Parameters

strPath string

The path.

bAutoSave bool

The auto save state.

bUseBackUpFile bool

The backup flag.

Save(string, bool)

save document with autosave.

public void Save(string strPath, bool bAutoSave)

Parameters

strPath string

The path.

bAutoSave bool

The auto save state.

SaveDocument(string, Dictionary)

public void SaveDocument(string strPath, Dictionary<string string> mapSubPath)

Parameters

strPath string

mapSubPath Dictionarystring, string&gt;

SaveTemplateBasedXml(XmlWriter)

Saves the XML for template based document.

protected virtual void SaveTemplateBasedXml(XmlWriter A_0)

Parameters

A_0 XmlWriter

SetData(XmlNode)

Sets the analysis document information data.

public override void SetData(XmlNode reader)

Parameters

reader XmlNode

The reader.

SetHandle(UIntPtr)

Set document handle.

protected override void SetHandle(UIntPtr pDocHandle)

Parameters

pDocHandle UIntPtr

The document handle.

SetPickFromUnderCursor(ulong)

Set picked object.

public void SetPickFromUnderCursor(ulong keyObject)

Parameters

keyObject ulong

The object will be picked.

SetRenderingMode(enRenderingMode)

public void SetRenderingMode(Document3D.enRenderingMode mode)

Parameters

mode Document3D.enRenderingMode

SetSelectFromUnderCursor(ulong)

Set selected object.

public void SetSelectFromUnderCursor(ulong keyObject)

Parameters

keyObject ulong

The object will be selected.

SetSelectFromUnderCursor(ObjectBase)

Set selected object.

public void SetSelectFromUnderCursor(ObjectBase objUnderCursor)

Parameters

objUnderCursor ObjectBase

The object will be selected.

SetSelectionObject(List)

public virtual void SetSelectionObject(List<objectbase> lstObj)

Parameters

lstObj ListObjectBase&gt;

SetUnselectFromUnderCursor(ulong)

Set unselected object.

public void SetUnselectFromUnderCursor(ulong keyObject)

Parameters

keyObject ulong

The object will be unselected.

ShowHideObjectBases(bool, List)

public bool ShowHideObjectBases(bool bShow, List<objectbase> lstSel)

Parameters

bShow bool

lstSel ListObjectBase&gt;

Returns

bool

ShowHideWithSelectionObjects(bool)

show hide with Selection Objects.

public bool ShowHideWithSelectionObjects(bool bShow)

Parameters

bShow bool

Returns

bool

SkipAddToDSDLWithCategory(string)

public virtual bool SkipAddToDSDLWithCategory(string strCategory)

Parameters

strCategory string

Returns

bool

SkipAddToDSDLWithEntity(ObjectBase)

public virtual bool SkipAddToDSDLWithEntity(ObjectBase ob)

Parameters

ob ObjectBase

Returns

bool

SkipDelete(ObjectBase)

Skips the delete.

protected virtual bool SkipDelete(ObjectBase obj)

Parameters

obj ObjectBase

The obj.

Returns

bool

SkipObjectInWriting(ObjectBase)

Skip object in writing template.

protected virtual bool SkipObjectInWriting(ObjectBase obj)

Parameters

obj ObjectBase

The object.

Returns

bool

SkipShowHide(ObjectBase)

Skips the show hide.

protected virtual bool SkipShowHide(ObjectBase obj)

Parameters

obj ObjectBase

The obj.

Returns

bool

StartBasicOp(BasicOpType)

Start basic operation.

public void StartBasicOp(Document3D.BasicOpType type)

Parameters

type Document3D.BasicOpType

The type of basic operation.

StartCADImportLog(string)

Starts the CAD import log.

protected virtual void StartCADImportLog(string strLogPath)

Parameters

strLogPath string

The log path.

ToggleCuttingPlane(OMatrix)

public void ToggleCuttingPlane(OMatrix matOri)

Parameters

matOri OMatrix

ToggleCuttingPlane()

public void ToggleCuttingPlane()

UpdateEnable(ObjectBase, bool)

Update object to enable or disable.

public override void UpdateEnable(ObjectBase obj, bool bEnabled)

Parameters

obj ObjectBase

The object.

bEnabled bool

Whether object is enable.

UpdateInterface(ObjectBase, bool)

Update interface.

public override void UpdateInterface(ObjectBase obj, bool bInterfaced)

Parameters

obj ObjectBase

The object.

bInterfaced bool

Whether object is interfaced.

VerifyAllEntity()

verify all entity.

public bool VerifyAllEntity()

Returns

bool

WriteCategoryToXml(string, string, XmlWriter)

Write objects in specialized category to xml writer.

protected void WriteCategoryToXml(string strCategoryName, string strElementName, XmlWriter writer)

Parameters

strCategoryName string

The category name.

strElementName string

The element name.

writer XmlWriter

The writer.

WriteMessageForShowHide()

Writes the message for show hide.

protected virtual void WriteMessageForShowHide()

XmlDocumentReLoad(XmlReader)

Reload documnet.

public virtual void XmlDocumentReLoad(XmlReader reader)

Parameters

reader XmlReader

The reader.

Connect with Ansys