Method CreateInclusion2
CreateInclusion2(DocumentId, ElementId, string, DocumentId, string, List<string>, List<SmartObject>, List<string>, List<SmartDesignObject>, bool, ElementId, ElementId, bool, bool, bool, bool, Transform3D, bool)
Creates an inclusion operation in a document.
Declaration
[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ElementId CreateInclusion2(DocumentId inDocumentId, ElementId inPositioningId, string inOccurrenceName, DocumentId inDefinitionId, string inCode, List<string> inKernelDriverNames, List<SmartObject> inKernelDriverValues, List<string> inDesignDriverNames, List<SmartDesignObject> inDesignDriverValues, bool inAutomaticallyFillsRepresentations, ElementId inConfigurationId, ElementId inRigidGroupId, bool inIsRigid, bool inInheritsRigidGroups, bool inInheritsJoints, bool inInheritsForces, Transform3D inTransform, bool inIsFixed)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| ElementId | inPositioningId | Identifier of the positioning operation that will contain the inclusion, or Empty for creating a new one. |
| string | inOccurrenceName | Occurrence name, or null if none. |
| DocumentId | inDefinitionId | Identifier of the definition document of the part or assembly or family to include. |
| string | inCode | Instance code, or null if none. |
| List<string> | inKernelDriverNames | Instance kernel driver names, or null if none. |
| List<SmartObject> | inKernelDriverValues | Instance kernel driver values, or null if none. |
| List<string> | inDesignDriverNames | Instance design driver names, or null if none. |
| List<SmartDesignObject> | inDesignDriverValues | Instance design driver values, or null if none. |
| bool | inAutomaticallyFillsRepresentations | Automatically fills assembly representations with corresponding representations of mechanical document to include. |
| ElementId | inConfigurationId | Identifier of the configuration to use when including a mechanism assembly, or Empty otherwise. |
| ElementId | inRigidGroupId | Identifier of the rigid group in which to put new node entity, or Empty otherwise. |
| bool | inIsRigid | Whether to make a rigid inclusion when including a mechanism sub-assembly. |
| bool | inInheritsRigidGroups | Whether to inherit sub-assembly rigid groups (when |
| bool | inInheritsJoints | Whether to inherit sub-assembly joints (when |
| bool | inInheritsForces | Whether to inherit sub-assembly forces (when |
| Transform3D | inTransform | Transformation to apply. |
| bool | inIsFixed | Whether to fix the result of the inclusion. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the created inclusion operation. |
Remarks
Code is not null if document to include is a family which has a catalog.
Driver names and values are not null if document to include is a family which has drivers. In this case, driver names and values must match.
StartModification(string, bool) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.17.
Automatic creation of the positioning by specifying inPositioningId = Empty is available since v7.8.