WorksetTable.RenameWorkset Method

WorksetTableRenameWorkset Method

Renames the workset.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
public static void RenameWorkset(
	Document aDoc,
	WorksetId worksetId,
	string name
)
Public Shared Sub RenameWorkset ( 
	aDoc As Document,
	worksetId As WorksetId,
	name As String
)
public:
static void RenameWorkset(
	Document^ aDoc, 
	WorksetId^ worksetId, 
	String^ name
)
static member RenameWorkset : 
        aDoc : Document * 
        worksetId : WorksetId * 
        name : string -> unit

Parameters

aDoc  Document
The document in which the workset is accessed.
worksetId  WorksetId
The workset Id.
name  String
The workset name.
Exceptions
ExceptionCondition
ArgumentException aDoc is not a workshared document. -or- name is an empty string or contains only whitespace. -or- name cannot include prohibited characters, such as "{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~". -or- The given workset name is already in use. -or- There is no workset in the document with this id.
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.
See Also

M:Autodesk.Revit.DB.WorksetTable.RenameWorkset(Autodesk.Revit.DB.Document,Autodesk.Revit.DB.WorksetId,System.String)