FilteredWorksetCollector

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

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.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.FilteredWorksetCollector

public class FilteredWorksetCollector : IEnumerable<Workset>, 
	IDisposable

Public Class FilteredWorksetCollector
	Implements IEnumerable(Of Workset), IDisposable

public ref class FilteredWorksetCollector : IEnumerable<Workset^>, 
	IDisposable

type FilteredWorksetCollector = 
    class
        interface IEnumerable<Workset>
        interface IDisposable
    end

Name	Return Type	Description	Inherited From
C FilteredWorksetCollector(Document)	None	Constructs a new FilteredWorksetCollector that will search and filter the set of worksets in a document.

Name	Return Type	Description	Inherited From
M Dispose()	None	Releases all resources used by the FilteredWorksetCollector
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M FirstWorkset()	Workset	Returns the first workset to pass the filter(s).
M FirstWorksetId()	WorksetId	Returns the id of the first workset to pass the filter(s).
M GetBasicIEnumerator()	IEnumerator	Returns an enumerator that iterates through a collection.
M GetEnumerator()	IEnumerator<Workset>	Returns an enumerator that iterates through a collection.
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M GetWorksetIdIterator()	FilteredWorksetIdIterator	Returns a FilteredWorksetIdIterator to the worksets passing the current filter.
M GetWorksetIterator()	FilteredWorksetIterator	Returns a FilteredWorksetIterator to the worksets passing the current filter.
M OfKind(WorksetKind)	FilteredWorksetCollector	Applies a WorksetKindFilter to the collector.
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object
M ToWorksetIds()	ICollection<WorksetId>	Returns the complete set of workset ids that pass the filter(s).
M ToWorksets()	IList<Workset>	Returns the complete set of worksets that pass the filter(s).
M WherePasses(WorksetFilter)	FilteredWorksetCollector	Applies a workset filter to the collector.

Name	Return Type	Description	Inherited From
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.