FamilyInstance Properties


Family Instance Properties

The FamilyInstance type exposes the following members.

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