Revit 2018 API |
ParameterFilterElement..::..Create Method (Document, String, ICollection<(Of <(<'ElementId>)>)>, IList<(Of <(<'FilterRule>)>)>) |
ParameterFilterElement Class See Also |
Creates a new ParameterFilterElement in the given document.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 18.0.0.0 (18.2.0.13)
Since:
2011
Syntax
C# |
---|
public static ParameterFilterElement Create( Document aDocument, string name, ICollection<ElementId> categories, IList<FilterRule> rules ) |
Visual Basic |
---|
Public Shared Function Create ( _ aDocument As Document, _ name As String, _ categories As ICollection(Of ElementId), _ rules As IList(Of FilterRule) _ ) As ParameterFilterElement |
Visual C++ |
---|
public: static ParameterFilterElement^ Create( Document^ aDocument, String^ name, ICollection<ElementId^>^ categories, IList<FilterRule^>^ rules ) |
Parameters
- aDocument
- Type: Autodesk.Revit.DB..::..Document
The document in which to create the ParameterFilterElement.
- name
- Type: System..::..String
The user-visible name for the new ParameterFilterElement.
- categories
- Type: System.Collections.Generic..::..ICollection<(Of <(<'ElementId>)>)>
The categories for the new ParameterFilterElement.
- rules
- Type: System.Collections.Generic..::..IList<(Of <(<'FilterRule>)>)>
The rules for the new ParameterFilterElement.
Return Value
A pointer to the new ParameterFilterElement.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentException | name is an empty string or contains only whitespace. -or- name cannot include prohibited characters. -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. |
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was NULL |