Skip to main content

Collecting Worksets

1. Introduction to Worksets​

Worksets in Revit are collections of elements in a project that can be used to organize and manage large projects. They allow multiple team members to work on different parts of a project simultaneously. Understanding how to collect and filter worksets programmatically can greatly enhance your ability to manage and analyze Revit projects.

2. The FilteredWorksetCollector Class​

The FilteredWorksetCollector class is the primary tool for collecting worksets in Revit's API. It's specifically designed for worksets, as opposed to the FilteredElementCollector used for Revit elements.

Basic Usage:​

from Autodesk.Revit.DB import FilteredWorksetCollector, WorksetKind

# Assuming 'doc' is your active Revit document
collector = FilteredWorksetCollector(doc)

3. Collecting Worksets by Kind​

Revit has different kinds of worksets, each serving a specific purpose. The main types are:

  • Family Worksets
  • View Worksets
  • Standard Worksets
  • User Worksets

Example: Collecting Different Kinds of Worksets​

# Collect Family Worksets
family_worksets = FilteredWorksetCollector(doc).OfKind(WorksetKind.FamilyWorkset).ToWorksets()

# Collect View Worksets
view_worksets = FilteredWorksetCollector(doc).OfKind(WorksetKind.ViewWorkset).ToWorksets()

# Collect Standard Worksets
standard_worksets = FilteredWorksetCollector(doc).OfKind(WorksetKind.StandardWorkset).ToWorksets()

# Collect User Worksets
user_worksets = FilteredWorksetCollector(doc).OfKind(WorksetKind.UserWorkset).ToWorksets()

4. Filtering Worksets​

You can apply filters to the FilteredWorksetCollector to narrow down your selection based on various criteria.

Using WorksetKindFilter​

The WorksetKindFilter allows you to filter worksets based on their kind:

from Autodesk.Revit.DB import WorksetKindFilter

# Create a filter for User Worksets
user_workset_filter = WorksetKindFilter(WorksetKind.UserWorkset)

# Apply the filter to the collector
user_worksets = FilteredWorksetCollector(doc).WherePasses(user_workset_filter).ToWorksets()

Combining Filters​

You can combine multiple filters using logical operators:

from Autodesk.Revit.DB import LogicalOrFilter, WorksetVisibilityFilter

# Create filters
user_filter = WorksetKindFilter(WorksetKind.UserWorkset)
visible_filter = WorksetVisibilityFilter()

# Combine filters
combined_filter = LogicalOrFilter(user_filter, visible_filter)

# Apply combined filter
result_worksets = FilteredWorksetCollector(doc).WherePasses(combined_filter).ToWorksets()

5. Working with Collected Worksets​

Once you've collected worksets, you can perform various operations on them:

Iterating Through Worksets​

for workset in user_worksets:
    print(f"Workset Name: {workset.Name}")
    print(f"Workset ID: {workset.Id}")
    print(f"Is Default: {workset.IsDefaultWorkset}")
    print("---")

Checking Workset Properties​

def analyze_workset(workset):
    print(f"Analyzing Workset: {workset.Name}")
    print(f"  Kind: {workset.Kind}")
    print(f"  Is Editable: {workset.IsEditable}")
    print(f"  Is Open: {workset.IsOpen}")
    print(f"  Owner: {workset.Owner}")
    print("---")

# Analyze each user workset
for workset in user_worksets:
    analyze_workset(workset)

6. Best Practices and Tips​

  1. Performance: When dealing with large projects, consider using quick filters first to reduce the number of worksets before applying more intensive filters.

  2. Error Handling: Always wrap your code in try-except blocks to handle potential exceptions, especially when working with large datasets.

  3. Documentation: Keep your code well-documented, especially when creating custom filters or complex collection logic.

  4. Revit Version Compatibility: Be aware that some methods or properties might change between Revit versions. Always test your code on the target Revit version.

7. Conclusion​

Understanding how to collect and filter worksets programmatically is a powerful skill for Revit developers and BIM managers. It allows for efficient project organization, analysis, and automation of workset-related tasks. As you become more comfortable with these concepts, you'll be able to create more sophisticated tools to manage and optimize your Revit workflows.