Revit 2025 API
Parameter |
Creates a new ParameterFilterElement in the given document.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public static ParameterFilterElement Create( Document aDocument, string name, ICollection<ElementId> categories, ElementFilter elementFilter )
Public Shared Function Create ( aDocument As Document, name As String, categories As ICollection(Of ElementId), elementFilter As ElementFilter ) As ParameterFilterElement
public: static ParameterFilterElement^ Create( Document^ aDocument, String^ name, ICollection<ElementId^>^ categories, ElementFilter^ elementFilter )
static member Create : aDocument : Document * name : string * categories : ICollection<ElementId> * elementFilter : ElementFilter -> ParameterFilterElement
Parameters
- aDocument Document
- The document in which to create the ParameterFilterElement.
- name String
- The user-visible name for the new ParameterFilterElement.
- categories ICollectionElementId
- The categories for the new ParameterFilterElement.
- elementFilter ElementFilter
-
The rules for the new ParameterFilterElement, represented as an ElementFilter.
ElementFilter is either an ElementParameterFilter or an ElementLogicalFilter
representing a Boolean combination of ElementParameterFilters. In addition, we check that
each ElementParameterFilter satisfies the following conditions:
Its array of FilterRules is not empty and contains:
- Any number of FilterRules of type FilterValueRule, FilterInverseRule, and SharedParameterApplicableRule or
- Exactly one FilterCategoryRule containing only one category from categories stored by this ParameterFilterElement or
- Exactly two rules: the first one is a FilterCategoryRule containing only one category from categories stored by this ParameterFilterElement and the second one is a FilterRule of type FilterValueRule, FilterInverseRule, or SharedParameterApplicableRule.
Return Value
ParameterFilterElementA pointer to the new ParameterFilterElement.

Exception | Condition |
---|---|
ArgumentException | name is an empty string or contains only whitespace. -or- name cannot include prohibited characters, such as "{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~". -or- The given value for name is already in use as a filter element name. -or- One of the given rules refers to a parameter that does not apply to this filter's categories. |
ArgumentNullException | A non-optional argument was null |
ArgumentsInconsistentException | The ElementFilter is not acceptable for use by a ParameterFilterElement. |
See Also