FamilyInstance

Description:
This object represents a single instance of a family type, such as a single I beam.

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.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Element
    Autodesk.Revit.DB.Instance
      Autodesk.Revit.DB.FamilyInstance
        Autodesk.Revit.DB.AnnotationSymbol
        Autodesk.Revit.DB.Mullion
        Autodesk.Revit.DB.Panel

public class FamilyInstance : Instance

Public Class FamilyInstance _
	Inherits Instance

public ref class FamilyInstance : public Instance

public void GetInfo_FamilyInstance(FamilyInstance familyInstance)
{
    string message = "FamilyInstance : ";
    // Get FamilyInstance host name
    if (familyInstance.Host != null)
    {
        message += "\nFamilyInstance host name is : " + familyInstance.Host.Name;
    }

    foreach (ElementId materialId in familyInstance.GetMaterialIds(false))
    {
        Material material = familyInstance.Document.GetElement(materialId) as Material;
        message += "\nFamilyInstance e material : " + material.Name;
    }
    // Get FamilyInstance room name
    if (familyInstance.Room != null)
    {
        message += "\nFamilyInstance room name is : " + familyInstance.Room.Name;
    }

    // Get FamilyInstance structural type
    message += "\nFamilyInstance structural type is : " + familyInstance.StructuralType;

    // Get FamilyInstance structural usage
    message += "\nFamilyInstance structural usage is : " + familyInstance.StructuralUsage;

    TaskDialog.Show("Revit",message);
}

Public Sub GetInfo_FamilyInstance(familyInstance As FamilyInstance)
 Dim message As String = "FamilyInstance : "

 ' Get FamilyInstance host name
 If familyInstance.Host IsNot Nothing Then
        message += vbLf & "FamilyInstance host name is : " & Convert.ToString(familyInstance.Host.Name)
    End If

    For Each materialId As ElementId In familyInstance.GetMaterialIds(False)
        Dim material As Material = TryCast(familyInstance.Document.GetElement(materialId), Material)
        message += vbLf & "FamilyInstance e material : " + material.Name
    Next
    ' Get FamilyInstance room name
    If familyInstance.Room IsNot Nothing Then
        message += vbLf & "FamilyInstance room name is : " & Convert.ToString(familyInstance.Room.Name)
    End If

    ' Get FamilyInstance structural type
    message += vbLf & "FamilyInstance structural type is : " & Convert.ToString(familyInstance.StructuralType)

    ' Get FamilyInstance structural usage
    message += vbLf & "FamilyInstance structural usage is : " & Convert.ToString(familyInstance.StructuralUsage)

    TaskDialog.Show("Revit", message)
End Sub

Name	Return Type	Description	Inherited From
M AddCoping(FamilyInstance)	bool	Adds a coping (cut) to a steel beam.
M flipFacing()	bool	The orientation of family instance facing will be flipped. If it can not be flipped, return false, otherwise return true.
M FlipFromToRoom()	None	Flips the settings of "From Room" and "To Room" for the door or window instance.
M flipHand()	bool	The orientation of family instance hand will be flipped. If it can not be flipped, return false, otherwise return true.
M GetCopingIds()	The coping ElementIds	Lists the elements currently used as coping cutters for this element.
M GetFamilyPointPlacementReferences()	IList<FamilyPointPlacementReference>	Returns the Point Placement References for the Family Instance.
M GetOriginalGeometry(Options)	GeometryElement	Returns the original geometry of the instance, before the instance is modified by joins, cuts, coping, extensions, or other post-processing.
M GetReferenceByName(String)	Reference	Gets the family instance reference corresponding to the named reference plane in the instance's family.
M GetReferenceName(Reference)	string	Gets the name of the reference plane in the family corresponding to the given family instance reference.
M GetReferences(FamilyInstanceReferenceType)	IList<Reference>	Gets family instance references corresponding to the reference planes or reference lines of the given reference type in the instance's family.
M GetReferenceType(Reference)	FamilyInstanceReferenceType	Gets the type of the reference plane or reference line in the instance's family corresponding to the given family instance reference.
M GetSpatialElementCalculationPoint()	A 3d point.	Gets the location of the calculation point for this instance.
M GetSpatialElementFromToCalculationPoints()	IList<XYZ>	Gets the locations for the calculation points for this instance.
M GetSubComponentIds()	The subcomponent ElementIDs	Gets the sub component ElementIds of the current family instance.
M GetSweptProfile()	A swept profile.	Gets the object that describes the profile that is swept along the driving curve for this instance.
M HasModifiedGeometry()	bool	Identifies if the geometry of this FamilyInstance has been modified from the automatically generated default.
M HasSweptProfile()	bool	Indicates if this instance can be represented as a swept profile.
M RemoveCoping(FamilyInstance)	bool	Removes a coping (cut) from a steel beam.
M rotate()	bool	The family instance will be flipped by 180 degrees. If it can not be rotated, return false, otherwise return true.
M SetCopingIds(ICollection<ElementId>)	bool	Specifies the set of coping cutters on this element.
M Split(Double)	ElementId	Splits the family instance element at a point on its defining curve.
M ArePhasesModifiable()	bool	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.	Element
M CanBeHidden(View)	bool	Indicates if the element can be hidden in the view.	Element
M CanBeLocked()	bool	Identifies if the element can be locked.	Element
M CanDeleteSubelement(Subelement)	bool	Checks if given subelement can be removed from the element.	Element
M CanHaveTypeAssigned()	bool	Identifies if the element can have a type assigned.	Element
M CanHaveTypeAssigned(Document, ICollection<ElementId>)	bool	Checks if all elements in the set can have a type assigned.	Element
M ChangeTypeId(Document, ICollection<ElementId>, ElementId)	IDictionary	Changes the type of all elements in the given set.	Element
M ChangeTypeId(ElementId)	ElementId	Changes the type of the element.	Element
M DeleteEntity(Schema)	bool	Deletes the existing entity created by %schema% in the element	Element
M DeleteSubelement(Subelement)	bool	Removes a subelement from the element.	Element
M DeleteSubelements(IList<Subelement>)	bool	Removes the subelements from the element.	Element
M Dispose()	None	Releases all resources used by the	Element
M GetChangeTypeAny()	ChangeType	Returns ChangeType associated with any change in an element.	Element
M GetChangeTypeElementAddition()	ChangeType	Returns ChangeType associated with element addition	Element
M GetChangeTypeElementDeletion()	ChangeType	Returns ChangeType associated with element deletion.	Element
M GetChangeTypeGeometry()	ChangeType	Returns ChangeType associated with a change in the geometry of an element	Element
M GetChangeTypeParameter(ElementId)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetChangeTypeParameter(Parameter)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetDependentElements(ElementFilter)	IList<ElementId>	Get all elements that, from a logical point of view, are the children of this Element.	Element
M GetEntity(Schema)	The returned Entity.	Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.	Element
M GetEntitySchemaGuids()	IList<Guid>	Returns the Schema guids of any Entities stored in this element.	Element
M GetExternalFileReference()	ExternalFileReference	Gets information pertaining to the external file referenced by the element.	Element
M GetExternalResourceReferenceExpanded(ExternalResourceType)	IList<ExternalResourceReference>	Gets the collection of ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReference(ExternalResourceType)	ExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReferencesExpanded()	IDictionary	Gets the expanded map of the external resource references referenced by the element.	Element
M GetExternalResourceReferences()	IDictionary	Gets the map of the external resource references referenced by the element.	Element
M GetGeneratingElementIds(GeometryObject)	ICollection<ElementId>	Returns the ids of the element(s) that generated the input geometry object.	Element
M GetGeometryObjectFromReference(Reference)	GeometryObject	Retrieve one geometric primitive contained in the element given a reference.	Element
M GetMaterialArea(ElementId, Boolean)	double	Gets the area of the material with the given id.	Element
M GetMaterialIds(Boolean)	ICollection<ElementId>	Gets the element ids of all materials present in the element.	Element
M GetMaterialVolume(ElementId)	double	Gets the volume of the material with the given id.	Element
M GetMonitoredLinkElementIds()	IList<ElementId>	Provides the link instance IDs when the element is monitoring.	Element
M GetMonitoredLocalElementIds()	IList<ElementId>	Provides the local element IDs when the element is monitoring.	Element
M GetOrderedParameters()	IList<Parameter>	Gets the parameters associated to the element in order.	Element
M GetParameterFormatOptions(ElementId)	FormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.	Element
M GetParameter(ForgeTypeId)	Parameter	Retrieves a parameter from the element given identifier.	Element
M GetParameters(String)	IList<Parameter>	Retrieves the parameters from the element via the given name.	Element
M GetPhaseStatus(ElementId)	ElementOnPhaseStatus	Gets the status of a given element in the input phase	Element
M GetSubelements()	IList<Subelement>	Returns the collection of element subelements.	Element
M GetTypeId()	ElementId	Returns the identifier of this element's type.	Element
M GetValidTypes()	ICollection<ElementId>	Obtains a set of types that are valid for this element.	Element
M GetValidTypes(Document, ICollection<ElementId>)	ICollection<ElementId>	Obtains a set of types that are valid for all given elements.	Element
M HasPhases()	bool	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.	Element
M IsCreatedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsDemolishedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsExternalFileReference()	bool	Determines whether this Element represents an external file.	Element
M IsHidden(View)	bool	Identifies if the element has been permanently hidden in the view.	Element
M IsMonitoringLinkElement()	bool	Indicate whether an element is monitoring any elements in any linked models.	Element
M IsMonitoringLocalElement()	bool	Indicate whether an element is monitoring other local elements.	Element
M IsPhaseCreatedValid(ElementId)	bool	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.	Element
M IsPhaseDemolishedValid(ElementId)	bool	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.	Element
M IsValidType(Document, ICollection<ElementId>, ElementId)	bool	Checks if given type is valid for the set of elements.	Element
M IsValidType(ElementId)	bool	Checks if given type is valid for this element.	Element
M LookupParameter(String)	nullNothingnullptr	Attempts to find a parameter on the element which has the given name.	Element
M RefersToExternalResourceReference(ExternalResourceType)	bool	Determines whether this Element uses external resources associated with a specified external resource type.	Element
M RefersToExternalResourceReferences()	bool	Determines whether this Element uses external resources.	Element
M SetEntity(Entity)	None	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.	Element
M GetTotalTransform()	Transform	Gets the total transform, which includes the true north transform for instances like import instances.	Instance
M GetTransform()	The inherent transform.	Gets the transform of the instance.	Instance

Name	Return Type	Description	Inherited From
P CanFlipFacing	bool	Property to test whether the orientation of family instance facing can be flipped.
P CanFlipHand	bool	Property to test whether the orientation of family instance hand can be flipped.
P CanFlipWorkPlane	bool	Identifies if the instance can flip its work plane.
P CanRotate	bool	Property to test whether the family instance can be rotated by 180 degrees.
P CanSplit	bool	Identifies whether a particular family instance can be split at a point on it's defining curve (by ).
P ExtensionUtility	IExtension	Property to check whether the instance can be extended and return the interface for extension operation.
P FacingFlipped	bool	Property to test whether the orientation of family instance facing is flipped.
P FacingOrientation	XYZ	Property to get the orientation of family instance facing.
P FromRoom	Room	The "From Room" set for the door or window in the last phase of the project.
P FromRoom	Room
P HandFlipped	bool	Property to test whether the orientation of family instance hand is flipped.
P HandOrientation	XYZ	Property to get the orientation of family instance hand.
P HasSpatialElementCalculationPoint	bool	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.
P HasSpatialElementFromToCalculationPoints	bool	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.
P HostFace	Reference	Property to get the reference to the host face of family instance.
P HostParameter	double	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.
P Host	Element	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.
P Invisible	bool	Property to test whether the family instance is invisible.
P IsSlantedColumn	bool	Indicates if the family instance is a slanted column.
P IsWorkPlaneFlipped	bool	Identifies if the instance's work plane is flipped.
P Location	Location	This property is used to find the physical location of an instance within project.
P MEPModel	MEPModel	Retrieves the MEP model for the family instance.
P Mirrored	bool	Property to test whether the family instance is mirrored. (only one axis is flipped)
P Room	Room	The room in which the instance is located (during the last phase of the project).
P Room	Room
P Space	Space	The space in which the instance is located (during the last phase of the project).
P Space	Space
P StructuralMaterialId	ElementId	Identifies the material that defines the instance's structural analysis properties.
P StructuralMaterialType	StructuralMaterialType	This property returns the physical material from which the instance is made.
P StructuralType	StructuralType	Provides the primary structural type of the instance, such as beam or column etc.
P StructuralUsage	StructuralInstanceUsage	Provides the primary structural usage of the instance, such as brace, girder etc.
P SuperComponent	Element	Property to get the super component of current family instance.
P Symbol	FamilySymbol	Returns or changes the FamilySymbol object that represents the type of the instance.
P ToRoom	Room	The "To Room" set for the door or window in the last phase of the project.
P ToRoom	Room
P AssemblyInstanceId	ElementId	The id of the assembly instance to which the element belongs.	Element
P BoundingBox	BoundingBoxXYZ	Retrieves a box that circumscribes all geometry of the element.	Element
P Category	Category	Retrieves a Category object that represents the category or sub category in which the element resides.	Element
P CreatedPhaseId	ElementId	Id of a Phase at which the Element was created.	Element
P DemolishedPhaseId	ElementId	Id of a Phase at which the Element was demolished.	Element
P DesignOption	DesignOption	Returns the design option to which the element belongs.	Element
P Document	Document	Returns the Document in which the Element resides.	Element
P Geometry	GeometryElement	Retrieves the geometric representation of the element.	Element
P GroupId	ElementId	The id of the group to which an element belongs.	Element
P Id	ElementId	A unique identifier for an Element in an Autodesk Revit project.	Element
P IsModifiable	bool	Identifies if the element is modifiable.	Element
P IsTransient	bool	Indicates whether an element is transient or permanent.	Element
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.	Element
P LevelId	ElementId	The id of the level associated with the element.	Element
P Location	Location	This property is used to find the physical location of an element within a project.	Element
P Name	string	A human readable name for the Element.	Element
P OwnerViewId	ElementId	The id of the view that owns the element.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a parameter id.	Element
P Parameter	Parameter	Retrieves a parameter from the element based on its definition.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a GUID for a shared parameter.	Element
P ParametersMap	ParameterMap	Retrieves a map containing all of the parameters that are contained within the element.	Element
P Parameters	ParameterSet	Retrieves a set containing all of the parameters that are contained within the element.	Element
P Pinned	bool	Identifies if the element has been pinned to prevent changes.	Element
P UniqueId	string	A stable unique identifier for an element within the document.	Element
P VersionGuid	Guid	Get the element version Guid.	Element
P ViewSpecific	bool	Identifies if the element is owned by a view.	Element
P WorksetId	WorksetId	Get Id of the Workset which owns the element.	Element