## On this page

  

 

 # Class ChainedSystemAPI

 Last update: 09.03.2026 

<a id="VM_API_Pre_Links_ChainedSystemAPI"></a>

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

This class implements APIs for chained system.

```csharp
public static class ChainedSystemAPI

```

#### Inheritance

object ← [ChainedSystemAPI](VM.API.Pre.Links.ChainedSystemAPI.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_ChainedSystemAPI_AddObjectToActiveDocument_VM_API_Pre_Obj_System_Int32_System_Int32_System_Collections_Generic_IEnumerable_System_String__System_Collections_Generic_IEnumerable_VM_TMatrix__System_Collections_Generic_IEnumerable_VM_Managed_Document3D__System_Boolean_"></a> AddObjectToActiveDocument(Obj, int, int, IEnumerable&lt;string&gt;, IEnumerable&lt;TMatrix&gt;, IEnumerable&lt;Document3D&gt;, bool)

Add object to active document.

```csharp
[NotNullObj(new string[] { "chainedPlacing" })]
[NotNull(new string[] { "preFixed", "transforms", "segmentDocuments" })]
[MatchTypeObj(new object[] { "chainedPlacing", typeof(ChainedPlacing) })]
public static IEnumerable<Obj> AddObjectToActiveDocument(this Obj chainedPlacing, int numberOfSegment, int numberOfSegmentData, IEnumerable<string> preFixed, IEnumerable<TMatrix> transforms, IEnumerable<Document3D> segmentDocuments, bool isCreate)

```

#### Parameters

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

The chained placing to add object.

`numberOfSegment` int

The number of segment.

`numberOfSegmentData` int

The number of segment data.

`preFixed` IEnumerable&lt;string&gt;

The pre-fixed names. The length is 'numberOfSegmentData'.

`transforms` IEnumerable&lt;TMatrix&gt;

The segment transforms. The length is 'numberOfSegment'.

`segmentDocuments` IEnumerable&lt;Document3D&gt;

The segment data documents. The length is 'numberOfSegmentData'.

`isCreate` bool

The create flag. If operation is modify state, You can put the value in 'false'.

#### Returns

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

The new segment list

#### Exceptions

ArgumentNullException

Will be thrown if 'chainedPlacing' arguments are empty.

ArgumentException

Will be thrown if type of 'chainedPlacing' is not .

ArgumentException

Will be thrown if type of 'preFixed', 'transforms', 'segmentDocuments' arguments are empty.

ArgumentException

Will be thrown if 'numberOfSegmentData' value is greater than 'numberOfSegment' value.

ArgumentException

Will be thrown if the length of 'preFixed' is not equal 'numberOfSegmentData' value.

ArgumentException

Will be thrown if the length of 'segmentDocuments' is not equal 'numberOfSegmentData' value.

ArgumentException

Will be thrown if the length of 'transforms' is not equal 'numberOfSegment' value.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_ChangeObjectLayer_VM_API_Pre_Obj_System_Collections_Generic_IEnumerable_VM_API_Pre_Obj__System_Collections_Generic_IEnumerable_System_Boolean__"></a> ChangeObjectLayer(Obj, IEnumerable&lt;Obj&gt;, IEnumerable&lt;bool&gt;)

Change object layer.

```csharp
[NotNullObj(new string[] { "chainedPlacing" })]
[NotNull(new string[] { "visibleObjects", "visibleStates" })]
[MatchTypeObj(new object[] { "chainedPlacing", typeof(ChainedPlacing) })]
public static void ChangeObjectLayer(this Obj chainedPlacing, IEnumerable<Obj> visibleObjects, IEnumerable<bool> visibleStates)

```

#### Parameters

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

The chained placing to change object.

`visibleObjects` IEnumerable&lt;[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)&gt;

The objects to be changed.

`visibleStates` IEnumerable&lt;bool&gt;

The vislble flags.

#### Exceptions

ArgumentNullException

Will be thrown if 'chainedPlacing' arguments are empty.

ArgumentException

Will be thrown if type of 'chainedPlacing' is not .

ArgumentException

Will be thrown if type of 'visibleObjects', 'visibleStates' argument is empty.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateCenter_VM_Managed_DAFUL_Chained_DocumentChainedPath_System_String_System_Nullable_System_Drawing_Color__System_Boolean_"></a> CreateCenter(DocumentChainedPath, string, Color?, bool)

Create center roller  with  builder.

```csharp
public static Obj CreateCenter(this DocumentChainedPath document, string bodyName = "", Color? color = null, bool isInterface = false)

```

#### Parameters

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

The document to create the center roller solid body.

`bodyName` string

The name of the . If empty, default name starts with 'BD\_' will be generated and used.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

`isInterface` bool

'true' if it is interface body. Otherwise, 'false'.

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateCenter_VM_Managed_DAFUL_Chained_PartDocumentChainedPath_System_Nullable_System_Drawing_Color__"></a> CreateCenter(PartDocumentChainedPath, Color?)

Create center roller  with  builder in part.

```csharp
public static Obj CreateCenter(this PartDocumentChainedPath document, Color? color = null)

```

#### Parameters

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

The document to create the center roller body.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateChainedSystem_VM_Managed_DAFUL_SubSystemDocument_System_Collections_Generic_IEnumerable_VM_API_Pre_Obj__System_String_"></a> CreateChainedSystem(SubSystemDocument, IEnumerable&lt;Obj&gt;, string)

Create chained system .

```csharp
[NotNull(new string[] { "document", "pathList" })]
public static Obj CreateChainedSystem(this SubSystemDocument document, IEnumerable<Obj> pathList, string name = "")

```

#### Parameters

`document` [SubSystemDocument](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/Data/VMDFBase/SubSystemDocument.cs)

The document to create the chained system.

`pathList` IEnumerable&lt;[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)&gt;

The path list.

`name` string

The name of the . If empty, default name starts with 'CPlacing\_' will be generated and used.

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' , 'pathList' are null.

ArgumentException

Will be thrown if item type of 'pathList' is not .

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateDouble_VM_Managed_DAFUL_Chained_DocumentChainedPath_System_String_System_Nullable_System_Drawing_Color__System_Boolean_"></a> CreateDouble(DocumentChainedPath, string, Color?, bool)

Create double roller  with  builder.

```csharp
public static Obj CreateDouble(this DocumentChainedPath document, string bodyName = "", Color? color = null, bool isInterface = false)

```

#### Parameters

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

The document to create the double roller solid body.

`bodyName` string

The name of the . If empty, default name starts with 'BD\_' will be generated and used.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

`isInterface` bool

'true' if it is interface body. Otherwise, 'false'.

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateDouble_VM_Managed_DAFUL_Chained_PartDocumentChainedPath_System_Nullable_System_Drawing_Color__"></a> CreateDouble(PartDocumentChainedPath, Color?)

Create double roller  with  builder in part.

```csharp
public static Obj CreateDouble(this PartDocumentChainedPath document, Color? color = null)

```

#### Parameters

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

The document to create the double roller body.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateFlat_VM_Managed_DAFUL_Chained_DocumentChainedPath_System_String_System_Nullable_System_Drawing_Color__System_Boolean_"></a> CreateFlat(DocumentChainedPath, string, Color?, bool)

Create flat roller  with  builder.

```csharp
public static Obj CreateFlat(this DocumentChainedPath document, string bodyName = "", Color? color = null, bool isInterface = false)

```

#### Parameters

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

The document to create the flat roller solid body.

`bodyName` string

The name of the . If empty, default name starts with 'BD\_' will be generated and used.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

`isInterface` bool

'true' if it is interface body. Otherwise, 'false'.

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateFlat_VM_Managed_DAFUL_Chained_PartDocumentChainedPath_System_Nullable_System_Drawing_Color__"></a> CreateFlat(PartDocumentChainedPath, Color?)

Create flat roller  with  builder in part.

```csharp
public static Obj CreateFlat(this PartDocumentChainedPath document, Color? color = null)

```

#### Parameters

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

The document to create the flat roller body.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateGeneral_VM_Managed_DAFUL_Chained_DocumentChainedPath_System_String_System_Nullable_System_Drawing_Color__System_Boolean_"></a> CreateGeneral(DocumentChainedPath, string, Color?, bool)

Create general roller  with  builder.

```csharp
public static Obj CreateGeneral(this DocumentChainedPath document, string bodyName = "", Color? color = null, bool isInterface = false)

```

#### Parameters

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

The document to create the general roller solid body.

`bodyName` string

The name of the . If empty, default name starts with 'BD\_' will be generated and used.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

`isInterface` bool

'true' if it is interface body. Otherwise, 'false'.

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateGeneral_VM_Managed_DAFUL_Chained_PartDocumentChainedPath_System_Nullable_System_Drawing_Color__"></a> CreateGeneral(PartDocumentChainedPath, Color?)

Create general roller  with  builder in part.

```csharp
public static Obj CreateGeneral(this PartDocumentChainedPath document, Color? color = null)

```

#### Parameters

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

The document to create the general roller body.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateSingle_VM_Managed_DAFUL_Chained_DocumentChainedPath_System_String_System_Nullable_System_Drawing_Color__System_Boolean_"></a> CreateSingle(DocumentChainedPath, string, Color?, bool)

Create single roller  with  builder.

```csharp
public static Obj CreateSingle(this DocumentChainedPath document, string bodyName = "", Color? color = null, bool isInterface = false)

```

#### Parameters

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

The document to create the single roller solid body.

`bodyName` string

The name of the . If empty, default name starts with 'BD\_' will be generated and used.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

`isInterface` bool

'true' if it is interface body. Otherwise, 'false'.

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateSingle_VM_Managed_DAFUL_Chained_PartDocumentChainedPath_System_Nullable_System_Drawing_Color__"></a> CreateSingle(PartDocumentChainedPath, Color?)

Create single roller  with  builder in part.

```csharp
public static Obj CreateSingle(this PartDocumentChainedPath document, Color? color = null)

```

#### Parameters

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

The document to create the single roller body.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateSprocket_VM_Managed_DAFUL_Chained_DocumentChainedPath_System_String_System_Nullable_System_Drawing_Color__System_Boolean_"></a> CreateSprocket(DocumentChainedPath, string, Color?, bool)

Create sprocket  with  builder.

```csharp
[NotNull(new string[] { "document" })]
public static Obj CreateSprocket(this DocumentChainedPath document, string bodyName = "", Color? color = null, bool isInterface = false)

```

#### Parameters

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

The document to create the sprocket solid body.

`bodyName` string

The name of the . If empty, default name starts with 'BD\_' will be generated and used.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

`isInterface` bool

'true' if it is interface body. Otherwise, 'false'.

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_CreateSprocket_VM_Managed_DAFUL_Chained_PartDocumentChainedPath_System_Nullable_System_Drawing_Color__"></a> CreateSprocket(PartDocumentChainedPath, Color?)

Create sprocket  with  builder in part.

```csharp
[NotNull(new string[] { "document" })]
public static Obj CreateSprocket(this PartDocumentChainedPath document, Color? color = null)

```

#### Parameters

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

The document to create the sprocket body.

`color` Color?

The color of the new flat roller geometry. The default value is '0xBFAAAA'

#### Returns

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

The new  object that is created by this API.

#### Exceptions

ArgumentNullException

Will be thrown if 'document' is null.

### <a id="VM_API_Pre_Links_ChainedSystemAPI_DeleteObjectList_VM_API_Pre_Obj_System_Collections_Generic_IEnumerable_VM_API_Pre_Obj__"></a> DeleteObjectList(Obj, IEnumerable&lt;Obj&gt;)

Add object to active document.

```csharp
[NotNullObj(new string[] { "chainedPlacing" })]
[NotNull(new string[] { "deletedObjects" })]
[MatchTypeObj(new object[] { "chainedPlacing", typeof(ChainedPlacing) })]
public static void DeleteObjectList(this Obj chainedPlacing, IEnumerable<Obj> deletedObjects)

```

#### Parameters

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

The chained placing to delete object.

`deletedObjects` IEnumerable&lt;[Obj](https://github.com/AnsysVirtualMotion/DAFUL/blob/9110677a5f6a53d7604f8dfd35b4c5fceb59e8e0/DAFUL/ClassicPre/API/VM.API.Pre/Models/Obj.cs)&gt;

The objects to be deleted.

#### Exceptions

ArgumentNullException

Will be thrown if 'chainedPlacing' arguments are empty.

ArgumentException

Will be thrown if type of 'chainedPlacing' is not .

ArgumentException

Will be thrown if type of 'deletedObjects' argument is empty.