## On this page

  

 

 # Class LinksDocumentAPI

 Last update: 09.03.2026 

<a id="VM_API_Pre_Links_LinksDocumentAPI"></a>

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

This class implements APIs for document.

```csharp
public static class LinksDocumentAPI

```

#### Inheritance

object ← [LinksDocumentAPI](VM.API.Pre.Links.LinksDocumentAPI.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_Links_LinksDocumentAPI_CreateNewPathMeshDocument_System_String_System_String_VM_Unit_VM_Plane_VM_API_Pre_LengthUnitType_"></a> CreateNewPathMeshDocument(string, string, Unit, Plane, LengthUnitType)

Create .

```csharp
public static MeshDocumentChainedPath CreateNewPathMeshDocument(string newLinkPathFilePath, string documentName = "MeshChainPath", Unit unit = null, Plane workingPlane = Plane.XZ, LengthUnitType kernelLengthUnit = LengthUnitType.M)

```

#### Parameters

`newLinkPathFilePath` string

The file path of new path mesh.

`documentName` string

The name of document. The default value is MeshChainPath.

`unit` Unit

The unit information.

`workingPlane` Plane

The working plane. The default value is XZ.

`kernelLengthUnit` LengthUnitType

The length unit of kernel. The default value is mm.

#### Returns

[MeshDocumentChainedPath](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDChainedBase/MeshDocumentChainedPath.cs)

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'newLinkPathFilePath' argument is null.

### <a id="VM_API_Pre_Links_LinksDocumentAPI_CreateNewPathPartDocument_System_String_System_String_VM_Unit_VM_Plane_VM_API_Pre_LengthUnitType_"></a> CreateNewPathPartDocument(string, string, Unit, Plane, LengthUnitType)

Create .

```csharp
public static PartDocumentChainedPath CreateNewPathPartDocument(string newLinkPathFilePath, string documentName = "PartChainPath", Unit unit = null, Plane workingPlane = Plane.XZ, LengthUnitType kernelLengthUnit = LengthUnitType.M)

```

#### Parameters

`newLinkPathFilePath` string

The file path of new path part.

`documentName` string

The name of document. The default value is PartChainPath.

`unit` Unit

The unit information.

`workingPlane` Plane

The working plane. The default value is XZ.

`kernelLengthUnit` LengthUnitType

The length unit of kernel. The default value is mm.

#### Returns

[PartDocumentChainedPath](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDChainedBase/PartDocumentChainedPath.cs)

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'newLinkPathFilePath' argument is null.

### <a id="VM_API_Pre_Links_LinksDocumentAPI_CreateNewPathSubsystemDocument_System_String_System_String_VM_Unit_VM_Plane_VM_API_Pre_LengthUnitType_"></a> CreateNewPathSubsystemDocument(string, string, Unit, Plane, LengthUnitType)

Create .

```csharp
public static DocumentChainedPath CreateNewPathSubsystemDocument(string newLinkPathFilePath, string documentName = "SubsystemChainPath", Unit unit = null, Plane workingPlane = Plane.XZ, LengthUnitType kernelLengthUnit = LengthUnitType.M)

```

#### Parameters

`newLinkPathFilePath` string

The file path of new path subsystem.

`documentName` string

The name of document. The default value is SubsystemChainPath.

`unit` Unit

The unit information.

`workingPlane` Plane

The working plane. The default value is XZ.

`kernelLengthUnit` LengthUnitType

The length unit of kernel. The default value is mm.

#### Returns

[DocumentChainedPath](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDChainedBase/DocumentChainedPath.cs)

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'newLinkPathFilePath' argument is null.

### <a id="VM_API_Pre_Links_LinksDocumentAPI_CreateNewSegmentMeshDocument_System_String_System_String_VM_Unit_VM_Plane_VM_API_Pre_LengthUnitType_"></a> CreateNewSegmentMeshDocument(string, string, Unit, Plane, LengthUnitType)

Create .

```csharp
public static MeshDocumentChainedSegment CreateNewSegmentMeshDocument(string newLinkSegmentFilePath, string documentName = "MeshChainSegment", Unit unit = null, Plane workingPlane = Plane.XZ, LengthUnitType kernelLengthUnit = LengthUnitType.M)

```

#### Parameters

`newLinkSegmentFilePath` string

The file path of new segment mesh.

`documentName` string

The name of document. The default value is MeshChainSegment.

`unit` Unit

The unit information.

`workingPlane` Plane

The working plane. The default value is XZ.

`kernelLengthUnit` LengthUnitType

The length unit of kernel. The default value is mm.

#### Returns

[MeshDocumentChainedSegment](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDChainedBase/MeshDocumentChainedSegment.cs)

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'newLinkSegmentFilePath' argument is null.

### <a id="VM_API_Pre_Links_LinksDocumentAPI_CreateNewSegmentPartDocument_System_String_System_String_VM_Unit_VM_Plane_VM_API_Pre_LengthUnitType_"></a> CreateNewSegmentPartDocument(string, string, Unit, Plane, LengthUnitType)

Create .

```csharp
public static PartDocumentChainedSegment CreateNewSegmentPartDocument(string newLinkSegmentFilePath, string documentName = "PartChainSegment", Unit unit = null, Plane workingPlane = Plane.XZ, LengthUnitType kernelLengthUnit = LengthUnitType.M)

```

#### Parameters

`newLinkSegmentFilePath` string

The file path of new segment part.

`documentName` string

The name of document. The default value is PartChainSegment.

`unit` Unit

The unit information.

`workingPlane` Plane

The working plane. The default value is XZ.

`kernelLengthUnit` LengthUnitType

The length unit of kernel. The default value is mm.

#### Returns

[PartDocumentChainedSegment](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDChainedBase/PartDocumentChainedSegment.cs)

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'newLinkSegmentFilePath' argument is null.

### <a id="VM_API_Pre_Links_LinksDocumentAPI_CreateNewSegmentSubsystemDocument_System_String_System_String_VM_Unit_VM_Plane_VM_API_Pre_LengthUnitType_"></a> CreateNewSegmentSubsystemDocument(string, string, Unit, Plane, LengthUnitType)

Create .

```csharp
public static DocumentChainedSegment CreateNewSegmentSubsystemDocument(string newLinkSegmentFilePath, string documentName = "SubsystemChainSegment", Unit unit = null, Plane workingPlane = Plane.XZ, LengthUnitType kernelLengthUnit = LengthUnitType.M)

```

#### Parameters

`newLinkSegmentFilePath` string

The file path of new segment subsystem.

`documentName` string

The name of document. The default value is SubsystemChainSegment.

`unit` Unit

The unit information.

`workingPlane` Plane

The working plane. The default value is XZ.

`kernelLengthUnit` LengthUnitType

The length unit of kernel. The default value is mm.

#### Returns

[DocumentChainedSegment](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDChainedBase/DocumentChainedSegment.cs)

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'newLinkSegmentFilePath' argument is null.