FilteredWorksetCollector

Public Class

This class is used to search, filter and iterate through a set of worksets.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.FilteredWorksetCollector

Namespace: Autodesk.Revit.DB

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

Syntax

public class FilteredWorksetCollector : IEnumerable<Workset>,
  IDisposable

The FilteredWorksetCollector type exposes the following members.

Constructors

Name

Description

---

Public Method
FilteredWorksetCollector

Constructs a new FilteredWorksetCollector that will search and filter the set of worksets in a document.

---

Properties

Name

Description

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the FilteredWorksetCollector

---

Public Method

Equals

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

---

Public Method
FirstWorkset

Returns the first workset to pass the filter(s).

---

Public Method
FirstWorksetId

Returns the id of the first workset to pass the filter(s).

---

Protected Method

GetBasicIEnumerator

Returns an enumerator that iterates through a collection.

---

Public Method

GetEnumerator

Returns an enumerator that iterates through a collection.

---

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
GetWorksetIdIterator

Returns a FilteredWorksetIdIterator to the worksets passing the current filter.

---

Public Method
GetWorksetIterator

Returns a FilteredWorksetIterator to the worksets passing the current filter.

---

Public Method
OfKind

Applies a WorksetKindFilter to the collector.

---

Public Method

ToString

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

---

Public Method
ToWorksetIds

Returns the complete set of workset ids that pass the filter(s).

---

Public Method
ToWorksets

Returns the complete set of worksets that pass the filter(s).

---

Public Method
WherePasses

Applies a workset filter to the collector.

---

Remarks

Developers can assign a condition to filter the worksets that are returned. If no condition is applied, it attempts to access all the worksets in the document.

The collector will reset if you call another method to extract worksets. Thus, if you have previously obtained an iterator, it will be stopped and traverse no more worksets if you call another method to extract worksets.