## On this page

  

 

 # Class MeshDocumentAPI

 Last update: 09.03.2026 

<a id="VM_API_Pre_FE_MeshDocumentAPI"></a>

Namespace: [VM.API.Pre.FE](VM.API.Pre.FE.md)  
Assembly: VM.API.Pre.FE.dll

This class implements APIs for  class.

```csharp
public static class MeshDocumentAPI

```

#### Inheritance

object ← [MeshDocumentAPI](VM.API.Pre.FE.MeshDocumentAPI.md)

#### 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&lt;T&gt;(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### <a id="VM_API_Pre_FE_MeshDocumentAPI_CreateNewMeshDocument_System_String_System_String_VM_Unit_System_Double_"></a> CreateNewMeshDocument(string, string, Unit, double)

Create .

```csharp
[NotNullOrEmpty(new string[] { "newMeshFilePath" })]
public static MeshDocument CreateNewMeshDocument(string newMeshFilePath, string documentName = "Mesh", Unit unit = null, double iconSize = 1)

```

#### Parameters

`newMeshFilePath` string

The file path of new mesh.

`documentName` string

The name of document.

`unit` Unit

The unit information.

`iconSize` double

The size of icon.

#### Returns

MeshDocument

The new SubSystemDocument object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'newMeshFilePath' argument is empty.

### <a id="VM_API_Pre_FE_MeshDocumentAPI_ImportMesh_VM_Managed_DAFUL_FE_MeshDocument_System_String_System_String_System_Nullable_System_Drawing_Color__System_Boolean_System_Boolean_"></a> ImportMesh(MeshDocument, string, string, Color?, bool, bool)

Import external mesh file such as bdf/dat into the

```csharp
[NotNull(new string[] { "doc" })]
[ExistFile(new string[] { "feDataFilePath" })]
public static Obj ImportMesh(this MeshDocument doc, string feDataFilePath, string modalDataFileName = "", Color? meshColor = null, bool degenerateElement = false, bool importOnlyRBEIncludingStaticCorrectionMode = false)

```

#### Parameters

`doc` MeshDocument

The  to import external mesh file.

`feDataFilePath` string

The path to the external mesh file.

`modalDataFileName` string

The path to the modal data file.

`meshColor` Color?

The  of the new mesh,

`degenerateElement` bool

The flag for degenerate element.

`importOnlyRBEIncludingStaticCorrectionMode` bool

The flag for import only rbe including static correction mode.

#### Returns

[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)

The new  object.

#### Exceptions

ArgumentNullException

Will be thrown when doc or feDataFilePath is null,

FileNotFoundException

Will be thrown if feDataFilePath file is not exist.

### <a id="VM_API_Pre_FE_MeshDocumentAPI_ModifyModal_VM_Managed_DAFUL_FE_MeshDocument_System_String_VM_Unit_System_Boolean_"></a> ModifyModal(MeshDocument, string, Unit, bool)

Create .

```csharp
[NotNull(new string[] { "doc" })]
[ExistFile(new string[] { "strModalFile" })]
public static void ModifyModal(this MeshDocument doc, string strModalFile, Unit unit = null, bool bOnlyDelete = false)

```

#### Parameters

`doc` MeshDocument

The  to modify modal.

`strModalFile` string

The path to the external modal file.

`unit` Unit

The unit information.

`bOnlyDelete` bool

The flag of deleting old modal data.

#### Exceptions

ArgumentNullException

Will be thrown when doc is null,

FileNotFoundException

Will be thrown if strModalFile file is not exist.