Namespace: Autodesk.Revit.DB

ElementWorksetFilter

Class

Description:
A filter used to match elements which reside in a given workset.

Remarks:
This filter is a quick filter.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ElementFilter
    Autodesk.Revit.DB.ElementQuickFilter
      Autodesk.Revit.DB.ElementWorksetFilter

Syntax

public class ElementWorksetFilter : ElementQuickFilter

Public Class ElementWorksetFilter
	Inherits ElementQuickFilter

public ref class ElementWorksetFilter : public ElementQuickFilter

type ElementWorksetFilter = 
    class
        inherit ElementQuickFilter
    end

Examples

public void WorksetElements(Document doc, Workset workset)
{
    // filter all elements that belong to the given workset
    FilteredElementCollector elementCollector = new FilteredElementCollector(doc);
    ElementWorksetFilter elementWorksetFilter = new ElementWorksetFilter(workset.Id);
    ICollection<Element> worksetElemsfounds = elementCollector.WherePasses(elementWorksetFilter).ToElements();

    // how many elements were found?
    int elementsCount = worksetElemsfounds.Count;
    String message = "Element count : " + elementsCount;

    // Get name and/or Id of the elements that pass the given filter and show a few of them
    int count = 5;  // show info for 5 elements only
    foreach (Element ele in worksetElemsfounds)
    {
        if (null != ele)
        {
           message += "\nElementId : " + ele.Id;
           message += ", Element Name : " + ele.Name;

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

    Autodesk.Revit.UI.TaskDialog.Show("ElementsOfWorkset", message);
}

Public Sub WorksetElements(doc As Document, workset As Workset)
    ' filter all elements that belong to the given workset
    Dim elementCollector As New FilteredElementCollector(doc)
    Dim elementWorksetFilter As New ElementWorksetFilter(workset.Id)
    Dim worksetElemsfounds As ICollection(Of Element) = elementCollector.WherePasses(elementWorksetFilter).ToElements()

    ' how many elements were found?
    Dim elementsCount As Integer = worksetElemsfounds.Count
    Dim message As [String] = "Element count : " + elementsCount

    ' Get name and/or Id of the elements that pass the given filter and show a few of them
    Dim count As Integer = 5
    ' show info for 5 elements only
    For Each ele As Element In worksetElemsfounds
        If ele IsNot Nothing Then
            message += vbLf & "ElementId : " + ele.Id.ToString
            message += ", Element Name : " + ele.Name

            If 0 = System.Threading.Interlocked.Decrement(count) Then
                Exit For
            End If
        End If
    Next

    Autodesk.Revit.UI.TaskDialog.Show("ElementsOfWorkset", message)
End Sub

ElementWorksetFilter Class Members:

Name	Description	Inherited From
ElementWorksetFilter(WorksetId)	Constructs a new instance of a filter to match elements in a given workset.
ElementWorksetFilter(WorksetId, Boolean)	Constructs a new instance of a filter to match elements in a given workset.

Name	Description	Inherited From
Inverted	True if the results of the filter are inverted; elements that would normally be accepted by this filter will be rejected, and elements that would normally be rejected will be accepted. (Inherited from ElementFilter )	ElementFilter
IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from ElementFilter )	ElementFilter
WorksetId	The workset id.

Name	Description	Inherited From
Dispose	(Inherited from ElementFilter )	ElementFilter
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
GetHashCode	Serves as the default hash function. (Inherited from Object )	Object
GetType	Gets the Type of the current instance. (Inherited from Object )	Object
PassesFilter(Element)	Applies the filter to a given element. (Inherited from ElementFilter )	ElementFilter
PassesFilter(Document, ElementId)	Applies the filter to a given element. (Inherited from ElementFilter )	ElementFilter
ToString	Returns a string that represents the current object. (Inherited from Object )	Object