Method CreateGripChangeTask

CreateGripChangeTask(DocumentId, bool, ElementId, List<ElementId>)

Creates a grip change task in a specified document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateGripChangeTask(DocumentId inDocumentId, bool inIsGripping, ElementId inGrippingRigidGroupId, List<ElementId> inRigidGroupIds)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
bool	inIsGripping	Whether the task is gripping, or otherwise dropping.
ElementId	inGrippingRigidGroupId	Identifier of gripping rigid group.
List<ElementId>	inRigidGroupIds	Identifiers of rigid groups that are gripped or dropped.

Returns

Type	Description
ElementId	Identifier of the created task.

Remarks

StartModification(string, bool) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.