Family Parameters
Families are an intrinsic part of any Revit model; being able to access their parameters is a vitally important skill when coding for Revit.
Last updated
Families are an intrinsic part of any Revit model; being able to access their parameters is a vitally important skill when coding for Revit.
Last updated
Revit's family system uses a hierarchical relationship between Family Types and Family Instances. The same relationship exists in parallel in the API:
Placed family instances (e.g. a window or a window) are instance of Revit's FamilyInstance class.
Family Types (e.g. 90 minute fire-rated door type) are instances of Revit's FamilyType class.
It is worth understanding a simple fact about family parameters:
A family's instance parameters are accessed via the FamilyInstance object, whereas family type parameters are accessed via the instance's FamilyType object.
Using a few simple methods, you can move from a family instance's FamilyInstance to its associated FamilyType, and from that FamilyType to the associated Family. We can also carry out the movements in reverse, finding all Family Types of a Family, or all placed instances of a Family Type. To make things clearer, we've put this on its own page:
As ever, if wanting to interact with a Revit element passed into a node, it will need to be unwrapped. See how to unwrap elements here: Unwrapping Revit Elements
Once unwrapped, you can either access a particular parameter (see section on Accessing a Specific Parameter below) or return a list of all the element's instance parameters as Parameter objects, which can be accessed via its Element.Parameters property, like so:
This is akin to using the Element.Parameters node on in Dynamo. Now we have the list of Parameter objects, we can do many things. Looking at the Parameter class in ApiDocs.co, we can see there are a number of useful properties we can inspect.
Type Parameters need to be accessed via an element’s family type. If you have a FamilyInstance as an input, you’ll firstly need to use an intermediate method to get the element’s FamilyType object, such as GetTypeId().
This method returns the ElementId of the element’s family type. We can then use the doc.GetElement() method to return the element’s FamilyType object. We can assign a reference to the family type, such as:
The family_type handle is now a way to access the family type object. We can then go about accessing parameters using the methods below.
Once we've placed a handle to our FamilyInstance or FamilyType, there are a couple of different ways to access a particular parameter:
The Element.LookupParameter() method.
The Element.get_Parameter() method.
Both of these methods essentially do the same thing; they return a Parameter object which you can inspect and manipulate.
Finally, in order to read a parameter object’s value, you’ll need to convert it using one of the methods of the Parameter class, such as .AsString() or .AsDouble(). If you output the raw Parameter object, it shows as Autodesk.Revit.DB.Parameter which isn't very helpful. Use the methods above to return the value in an appropriate data type. This workflow is the equivalent of using the GetParameterValueByName node in Dynamo.
