M

Workset.Create

Description:
Creates a new workset.

public static Workset Create(
	Document document,
	string name
)

Public Shared Function Create ( 
	document As Document,
	name As String
) As Workset

public:
static Workset^ Create(
	Document^ document, 
	String^ name
)

static member Create : 
        document : Document * 
        name : string -> Workset

Document

document

The document in which the new instance is created.
String

name

The workset name.

Return Value Workset Returns the newly created workset.

public Workset CreateWorkset(Document document)
{
    Workset newWorkset = null;
    // Worksets can only be created in a document with worksharing enabled
    if (document.IsWorkshared)
    {
        string worksetName = "New Workset";
        // Workset name must not be in use by another workset
        if (WorksetTable.IsWorksetNameUnique(document, worksetName))
        {
            using (Transaction worksetTransaction = new Transaction(document, "Set preview view id"))
            {
                worksetTransaction.Start();
                newWorkset = Workset.Create(document, worksetName);
                worksetTransaction.Commit();
            }
        }
    }

    return newWorkset;
}

ArgumentException

document 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.
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.