Namespace: Autodesk.Revit.DB Class: WorksetTable

WorksetTable.DeleteWorkset

Method

Description:
Delete the specific workset.

Remarks:
Please checkout the workset before executing this method. The method may fail in some situations that mentioned in CanDeleteWorkset(Document, WorksetId, DeleteWorksetSettings). Another failure case is the Transaction failure due to "Deleting all open views in a project is not allowed."

Syntax

public static void DeleteWorkset(
	Document document,
	WorksetId worksetId,
	DeleteWorksetSettings deleteWorksetSettings
)

Public Shared Sub DeleteWorkset ( 
	document As Document,
	worksetId As WorksetId,
	deleteWorksetSettings As DeleteWorksetSettings
)

public:
static void DeleteWorkset(
	Document^ document, 
	WorksetId^ worksetId, 
	DeleteWorksetSettings^ deleteWorksetSettings
)

static member DeleteWorkset : 
        document : Document * 
        worksetId : WorksetId * 
        deleteWorksetSettings : DeleteWorksetSettings -> unit

Parameters

Parameter	Type	Description
document	Document	The document containing the worksets.
worksetId	WorksetId	The id of the workset to delete.
deleteWorksetSettings	DeleteWorksetSettings	The settings to delete a workset.

Return Value

Exceptions

Exception	Condition
ArgumentException	document is not a workshared document. -or- document is not a primary document, it is a linked document. -or- document is read-only: It cannot be modified. -or- There is no workset in the document with this id. -or- Workset cannot be deleted.
ArgumentNullException	A non-optional argument was null
ModificationForbiddenException	The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process.
ModificationOutsideTransactionException	The document has no open transaction.
RegenerationFailedException	The document regeneration fails during the DeleteWorkset operation.