Revit 2025.3 API
Family |
This object represents a single instance of a family type, such as a single I beam.
Inheritance HierarchySystemObject
Autodesk.Revit.DBElement
Autodesk.Revit.DBInstance
Autodesk.Revit.DBFamilyInstance
Autodesk.Revit.DBAnnotationSymbol
Autodesk.Revit.DBMullion
Autodesk.Revit.DBPanel
Autodesk.Revit.DBElement
Autodesk.Revit.DBInstance
Autodesk.Revit.DBFamilyInstance
Autodesk.Revit.DBAnnotationSymbol
Autodesk.Revit.DBMullion
Autodesk.Revit.DBPanel
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
The FamilyInstance type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AssemblyInstanceId |
The id of the assembly instance to which the element belongs.
(Inherited from Element) |
| BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element) |
| CanFlipFacing | Property to test whether the orientation of family instance facing can be flipped. |
| CanFlipHand | Property to test whether the orientation of family instance hand can be flipped. |
| CanFlipWorkPlane | Identifies if the instance can flip its work plane. |
| CanRotate | Property to test whether the family instance can be rotated by 180 degrees. |
| CanSplit | Identifies whether a particular family instance can be split at a point on it's defining curve (by Split(Double)). |
| Category | Retrieves a Category object that represents the category or sub category in which the
element resides. (Inherited from Element) |
| CreatedPhaseId |
Id of a Phase at which the Element was created.
(Inherited from Element) |
| DemolishedPhaseId |
Id of a Phase at which the Element was demolished.
(Inherited from Element) |
| DesignOption | Returns the design option to which the element belongs. (Inherited from Element) |
| Document | Returns the Document in which the Element resides. (Inherited from Element) |
| ExtensionUtility | Property to check whether the instance can be extended and return the interface for extension operation. |
| FacingFlipped | Property to test whether the orientation of family instance facing is flipped. |
| FacingOrientation | Property to get the orientation of family instance facing. |
| FromRoom | The "From Room" set for the door or window in the last phase of the project. |
| FromRoomPhase | |
| Geometry | Retrieves the geometric representation of the element. (Inherited from Element) |
| GroupId |
The id of the group to which an element belongs.
(Inherited from Element) |
| HandFlipped | Property to test whether the orientation of family instance hand is flipped. |
| HandOrientation | Property to get the orientation of family instance hand. |
| HasSpatialElementCalculationPoint | Identifies if this instance has a single SpatialElementCalculationPoint used as the search point for Revit to identify if the instance is inside a room or space. |
| HasSpatialElementFromToCalculationPoints | Identifies if this instance has a pair of SpatialElementCalculationPoints used as the search points for Revit to identify if the instance lies between up to two rooms or spaces. |
| Host | If the instance is contained within another element, this property returns the containing element. An instance that is face hosted will return the element containing the face. |
| HostFace | Property to get the reference to the host face of family instance. |
| HostParameter | If the instance is hosted by a wall, this property returns the parameter value of the insertion point of the instance along the wall's location curve, as long as the family of the instance isn't work plane based. |
| Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element) |
| Invisible | Property to test whether the family instance is invisible. |
| IsModifiable |
Identifies if the element is modifiable.
(Inherited from Element) |
| IsSlantedColumn | Indicates if the family instance is a slanted column. |
| IsTransient |
Indicates whether an element is transient or permanent.
(Inherited from Element) |
| IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element) |
| IsWorkPlaneFlipped | Identifies if the instance's work plane is flipped. |
| LevelId |
The id of the level associated with the element.
(Inherited from Element) |
| Location | This property is used to find the physical location of an instance within project. (Overrides ElementLocation) |
| MEPModel | Retrieves the MEP model for the family instance. |
| Mirrored | Property to test whether the family instance is mirrored. (only one axis is flipped) |
| Name | A human readable name for the Element. (Inherited from Element) |
| OwnerViewId |
The id of the view that owns the element.
(Inherited from Element) |
| ParameterBuiltInParameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element) |
| ParameterDefinition | Retrieves a parameter from the element based on its definition. (Inherited from Element) |
| ParameterGuid | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element) |
| Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element) |
| ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element) |
| Pinned |
Identifies if the element has been pinned to prevent changes.
(Inherited from Element) |
| Room | The room in which the instance is located (during the last phase of the project). |
| RoomPhase | |
| Space | The space in which the instance is located (during the last phase of the project). |
| SpacePhase | |
| StructuralMaterialId | Identifies the material that defines the instance's structural analysis properties. |
| StructuralMaterialType | This property returns the physical material from which the instance is made. |
| StructuralType | Provides the primary structural type of the instance, such as beam or column etc. |
| StructuralUsage | Provides the primary structural usage of the instance, such as brace, girder etc. |
| SuperComponent | Property to get the super component of current family instance. |
| Symbol | Returns or changes the FamilySymbol object that represents the type of the instance. |
| ToRoom | The "To Room" set for the door or window in the last phase of the project. |
| ToRoomPhase | |
| UniqueId |
A stable unique identifier for an element within the document.
(Inherited from Element) |
| VersionGuid |
Get the element version Guid.
(Inherited from Element) |
| ViewSpecific |
Identifies if the element is owned by a view.
(Inherited from Element) |
| WorksetId |
Get Id of the Workset which owns the element.
(Inherited from Element) |
Methods| Name | Description | |
|---|---|---|
 | AddCoping | Adds a coping (cut) to a steel beam. |
| ArePhasesModifiable |
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element) |
| CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element) |
| CanBeLocked |
Identifies if the element can be locked.
(Inherited from Element) |
| CanDeleteSubelement |
Checks if given subelement can be removed from the element.
(Inherited from Element) |
| CanHaveTypeAssigned |
Identifies if the element can have a type assigned.
(Inherited from Element) |
| ChangeTypeId(ElementId) |
Changes the type of the element.
(Inherited from Element) |
| DeleteEntity |
Deletes the existing entity created by %schema% in the element
(Inherited from Element) |
| DeleteSubelement |
Removes a subelement from the element.
(Inherited from Element) |
| DeleteSubelements | (Inherited from Element) |
| Dispose | (Inherited from Element) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| EvaluateAllParameterValues |
Evaluates all the parameters' values of the element.
(Inherited from Element) |
| EvaluateParameterValues | (Inherited from Element) |
| flipFacing | The orientation of family instance facing will be flipped. If it can not be flipped, return false, otherwise return true. |
| FlipFromToRoom | Flips the settings of "From Room" and "To Room" for the door or window instance. |
| flipHand | The orientation of family instance hand will be flipped. If it can not be flipped, return false, otherwise return true. |
| GetCopingIds | Lists the elements currently used as coping cutters for this element. |
| GetDependentElements |
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element) |
| GetEntity |
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise.
(Inherited from Element) |
| GetEntitySchemaGuids |
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element) |
| GetExternalFileReference |
Gets information pertaining to the external file referenced
by the element.
(Inherited from Element) |
| GetExternalResourceReference |
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element) |
| GetExternalResourceReferenceExpanded |
Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element) |
| GetExternalResourceReferences |
Gets the map of the external resource references referenced
by the element.
(Inherited from Element) |
| GetExternalResourceReferencesExpanded |
Gets the expanded map of the external resource references referenced
by the element.
(Inherited from Element) |
| GetFamilyPointPlacementReferences | Returns the Point Placement References for the Family Instance. |
| GetGeneratingElementIds |
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element) |
| GetGeometryObjectFromReference |
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetMaterialArea |
Gets the area of the material with the given id.
(Inherited from Element) |
| GetMaterialIds |
Gets the element ids of all materials present in the element.
(Inherited from Element) |
| GetMaterialVolume |
Gets the volume of the material with the given id.
(Inherited from Element) |
| GetMonitoredLinkElementIds |
Provides the link instance IDs when the element is monitoring.
(Inherited from Element) |
| GetMonitoredLocalElementIds |
Provides the local element IDs when the element is monitoring.
(Inherited from Element) |
| GetOrderedParameters |
Gets the parameters associated to the element in order.
(Inherited from Element) |
| GetOriginalGeometry | Returns the original geometry of the instance, before the instance is modified by joins, cuts, coping, extensions, or other post-processing. |
| GetParameter | Retrieves a parameter from the element given identifier. (Inherited from Element) |
| GetParameterFormatOptions |
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element) |
| GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element) |
| GetPhaseStatus |
Gets the status of a given element in the input phase
(Inherited from Element) |
| GetReferenceByName | Gets the family instance reference corresponding to the named reference plane in the instance's family. |
| GetReferenceName | Gets the name of the reference plane in the family corresponding to the given family instance reference. |
| GetReferences | Gets family instance references corresponding to the reference planes or reference lines of the given reference type in the instance's family. |
| GetReferenceType | Gets the type of the reference plane or reference line in the instance's family corresponding to the given family instance reference. |
| GetSpatialElementCalculationPoint | Gets the location of the calculation point for this instance. |
| GetSpatialElementFromToCalculationPoints | Gets the locations for the calculation points for this instance. |
| GetSubComponentIds | Gets the sub component ElementIds of the current family instance. |
| GetSubelements |
Returns the collection of element subelements.
(Inherited from Element) |
| GetSweptProfile | Gets the object that describes the profile that is swept along the driving curve for this instance. |
| GetTotalTransform |
Gets the total transform, which includes the true north transform for instances like import instances.
(Inherited from Instance) |
| GetTransform |
Gets the transform of the instance.
(Inherited from Instance) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetTypeId |
Returns the identifier of this element's type.
(Inherited from Element) |
| GetValidTypes |
Obtains a set of types that are valid for this element.
(Inherited from Element) |
| HasModifiedGeometry | Identifies if the geometry of this FamilyInstance has been modified from the automatically generated default. |
| HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element) |
| HasSweptProfile | Indicates if this instance can be represented as a swept profile. |
| IsCreatedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element) |
| IsDemolishedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element) |
| IsExternalFileReference |
Determines whether this Element represents an external
file.
(Inherited from Element) |
| IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element) |
| IsMonitoringLinkElement |
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element) |
| IsMonitoringLocalElement |
Indicate whether an element is monitoring other local elements.
(Inherited from Element) |
| IsPhaseCreatedValid |
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element) |
| IsPhaseDemolishedValid |
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element) |
| IsValidType(ElementId) |
Checks if given type is valid for this element.
(Inherited from Element) |
| LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element) |
| RefersToExternalResourceReference |
Determines whether this Element uses external resources associated with
a specified external resource type.
(Inherited from Element) |
| RefersToExternalResourceReferences |
Determines whether this Element uses external resources.
(Inherited from Element) |
| RemoveCoping | Removes a coping (cut) from a steel beam. |
| rotate | The family instance will be flipped by 180 degrees. If it can not be rotated, return false, otherwise return true. |
| SetCopingIds | |
| SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from Element) |
| Split | Splits the family instance element at a point on its defining curve. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Remarks
Examples of FamilyInstance objects within Autodesk Revit are Beams, Columns,
Braces and Desks. The FamilyInstance object provides more detailed properties that
enable the type of the family instance to be changed, thus changing their appearance
within the project.
See Also