Element
|
A filter used to match elements which reside in a given workset.
Inheritance Hierarchy
System
Object
Autodesk.Revit.DB ElementFilter
Autodesk.Revit.DB ElementQuickFilter
Autodesk.Revit.DB ElementWorksetFilter
Autodesk.Revit.DB ElementFilter
Autodesk.Revit.DB ElementQuickFilter
Autodesk.Revit.DB ElementWorksetFilter
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 27.0.4.0 (27.0.4.0)
Syntax
The ElementWorksetFilter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
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. |
Properties
| Name | Description | |
|---|---|---|
|
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 ) |
|
|
IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from ElementFilter ) |
|
|
WorksetId | The workset id. |
Methods
| Name | Description | |
|---|---|---|
|
|
Dispose |
(Inherited from ElementFilter ) |
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from Object ) |
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from Object ) |
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from Object ) |
|
|
PassesFilter(Element) |
Applies the filter to a given element.
(Inherited from ElementFilter ) |
|
|
PassesFilter(Document, ElementId) |
Applies the filter to a given element.
(Inherited from ElementFilter ) |
|
|
ToString |
Returns a string that represents the current object.
(Inherited from Object ) |
Remarks
This filter is a quick filter.
Example
C#
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);
}