## On this page

  

 

 # Class LinksDocumentAPI

 Last update: 16.07.2025 

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](https://learn.microsoft.com/dotnet/api/system.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<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### 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.MM)

```

#### Parameters

`newLinkPathFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The file path of new path mesh.

`documentName` [string](https://learn.microsoft.com/dotnet/api/system.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

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'newLinkPathFilePath' argument is null.

### 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.MM)

```

#### Parameters

`newLinkPathFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The file path of new path part.

`documentName` [string](https://learn.microsoft.com/dotnet/api/system.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

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'newLinkPathFilePath' argument is null.

### 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.MM)

```

#### Parameters

`newLinkPathFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The file path of new path subsystem.

`documentName` [string](https://learn.microsoft.com/dotnet/api/system.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

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'newLinkPathFilePath' argument is null.

### 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.MM)

```

#### Parameters

`newLinkSegmentFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The file path of new segment mesh.

`documentName` [string](https://learn.microsoft.com/dotnet/api/system.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

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'newLinkSegmentFilePath' argument is null.

### 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.MM)

```

#### Parameters

`newLinkSegmentFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The file path of new segment part.

`documentName` [string](https://learn.microsoft.com/dotnet/api/system.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

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'newLinkSegmentFilePath' argument is null.

### 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.MM)

```

#### Parameters

`newLinkSegmentFilePath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The file path of new segment subsystem.

`documentName` [string](https://learn.microsoft.com/dotnet/api/system.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

The new  object that is created by this API.

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

Will be thrown if 'newLinkSegmentFilePath' argument is null.