Workset

Public Class

Represents a workset in the document.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.WorksetPreview
Autodesk.Revit.DB.Workset

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class Workset : WorksetPreview

The Workset type exposes the following members.

Properties

Name

Description

Public Property
Id

Id of the workset.
(Inherited from WorksetPreview)

Public Property

IsDefaultWorkset

Whether the workset is the default one.
(Inherited from WorksetPreview)

Public Property
IsEditable

Whether the workset is editable.

Public Property
IsOpen

Whether the workset is open (rather than closed).

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from WorksetPreview)

Public Property

IsVisibleByDefault

Whether the workset is visible by default.

Public Property

Kind

Kind of the workset.

Public Property
Name

Name of the workset.
(Inherited from WorksetPreview)

Public Property

Owner

User name of the workset.
(Inherited from WorksetPreview)

Public Property
UniqueId

UniqueId of the workset.
(Inherited from WorksetPreview)

Methods

Name

Description

Public Method
Static Member
Code Example

Create

Creates a new workset.

Public Method

Dispose

(Inherited from WorksetPreview)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

Worksets are a way to divide a set of elements in the Revit document into subsets for worksharing. There may be one or many worksets in a document. Each element in the document must belong to one and only one workset.

Example

public void GetWorksetsInfo(Document doc)
{
    String message = String.Empty;
    // Enumerating worksets in a document and getting basic information for each
    FilteredWorksetCollector collector = new FilteredWorksetCollector(doc);

    // find all user worksets
    collector.OfKind(WorksetKind.UserWorkset);

    // get information for each workset
    int count = 3;  // show info for 3 worksets only
    foreach (Workset workset in collector)
    {
        message += "Workset : " + workset.Name;
        message += "\nUnique Id : " + workset.UniqueId;
        message += "\nOwner : " + workset.Owner;
        message += "\nKind : " + workset.Kind;
        message += "\nIs default : " + workset.IsDefaultWorkset;
        message += "\nIs editable : " + workset.IsEditable;
        message += "\nIs open : " + workset.IsOpen;
        message += "\nIs visible by default : " + workset.IsVisibleByDefault;

        TaskDialog.Show("GetWorksetsInfo", message);

        if (0 == --count)
            break;
    }
}