WorksetId

Public Class

WorksetId identifies a workset within a single document.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.WorksetId

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

Syntax

public class WorksetId

The WorksetId type exposes the following members.

Constructors

Name

Description

Public Method
WorksetId

Create an WorksetId handle with the given integer id.

Properties

Name

Description

Public Property

IntegerValue

Provides the value of the WorksetId as an integer.

Public Property
Static Member

InvalidWorksetId

Get the invalid WorksetId whose IntegerValue is -1.

Methods

Name

Description

Public Method

Compare

Compares two WorksetIds.

Public Method

Equals

Determines whether the specified Object is equal to the current Object.
(Overrides Object.Equals(Object))

Public Method

GetHashCode

Gets the integer value of the id as hash code
(Overrides Object.GetHashCode.)

Public Method

GetType

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

Public Method

ToString

Gets a String representation of the integer value of the id.
(Overrides Object.ToString.)

Operators

Name

Description

Public Operator
Static Member
Equality(WorksetId, WorksetId)

Determines whether these two WorksetIds are the same.

Public Operator
Static Member
GreaterThan(WorksetId, WorksetId)

Determines whether one WorksetId is greater than another WorksetId.

Public Operator
Static Member
GreaterThanOrEqual(WorksetId, WorksetId)

Determines whether one WorksetId is not less than another WorksetId.

Public Operator
Static Member
Inequality(WorksetId, WorksetId)

Determines whether these two WorksetIds are different.

Public Operator
Static Member
LessThan(WorksetId, WorksetId)

Determines whether this WorksetId is less than another WorksetId.

Public Operator
Static Member
LessThanOrEqual(WorksetId, WorksetId)

Determines whether one WorksetId is not greater than another WorksetId.

Remarks

WorksetId is not guaranteed to be unique. It is only valid within one model and its value may change when the model is synchronized with central. If unique identification of a workset is needed, the workset’s GUID should be used instead.