BH.oM.Adapters.Revit.Requests.FilterLinkInstance¶

IRequest that filters all link instances with given file name/path, Name parameter value or ElementId from active Revit document. If link name field is left blank, all link instances in the document will be filtered.

Class structure¶

Implemented interfaces and base types¶

The FilterLinkInstance is inheriting from the following base type(s) and implements the following interfaces:

BH.oM.Data.Requests.IRequest
BH.oM.Base.IObject

Properties¶

Defining properties¶

The following properties are defined on the class

Name	Type	Description	Quantity
LinkName	string	Name of the link file (alternatively whole file path, Name parameter value or ElementId) used to filter the Revit link instances. Optional: if left blank, all link instances in the document will be filtered.	-
CaseSensitive	bool	If true: only perfect, case sensitive text match will be accepted. If false: capitals and small letters will be treated as equal.	-

Derived properties¶

The following properties are defined as extension methods in one of the BHoM_Engines

Name	Type	Description	Quantity	Engine
Discipline	Nullable<Discipline>	Gets discipline enforced by the Request. If the result is different than defaultDiscipline and neither of two is Undefined, null is returned (the result discipline is conflicting with defaultDiscipline).	-	Revit_Engine
IFilterDescription	string	Returns a description of the filter represented by the given IRequest.	-	Revit_Engine

Code and Schema¶

C# implementation¶

C#

public class FilterLinkInstance : BH.oM.Data.Requests.IRequest, BH.oM.Base.IObject

Assembly: Revit_oM.dll

The C# class definition is available on github:

FilterLinkInstance.cs

All history and changes of the class can be found by inspection the history.

JSON Schema implementation¶

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema

{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Revit_oM/Requests/FilterLinkInstance.json"
}

The JSON Schema is available on github here:

FilterLinkInstance.json