Sign in
2021 Members
Changes 4
M

FamilyInstance

Name Return Type Description Inherited From
M AddCoping(FamilyInstance) bool Adds a coping (cut) to a steel beam.
M ArePhasesModifiable() bool Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element .) Element
M CanBeHidden(View) bool Indicates if the element can be hidden in the view. (Inherited from Element .) Element
M CanBeLocked() bool Identifies if the element can be locked. (Inherited from Element .) Element
M CanDeleteSubelement(Subelement) bool Checks if given subelement can be removed from the element. (Inherited from Element .) Element
M CanHaveAnalyticalModel() bool Indicates whether the Element can have an Analytical Model. (Inherited from Element .) Element
M CanHaveTypeAssigned.() bool Identifies if the element can have a type assigned. (Inherited from Element .) Element
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element .) Element
M DeleteEntity(Schema) bool Deletes the existing entity created by %schema% in the element (Inherited from Element .) Element
M DeleteSubelement(Subelement) bool Removes a subelement from the element. (Inherited from Element .) Element
M DeleteSubelements(IList<Subelement>) bool Removes the subelements from the element. (Inherited from Element .) Element
M Dispose() None (Inherited from Element .) Element
M Equals None (Inherited from Object .) Object .
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 GetAnalyticalModel() Writeable Analytical Model. Retrieves writeable Analytical Model for Element. (Inherited from Element .) Element
M GetAnalyticalModelId() Element Id. Retrieves the Element Id of the Analytical Model Element for this Element. (Inherited from Element .) Element
M GetCopingIds() The coping ElementIds Lists the elements currently used as coping cutters for this element.
M GetDependentElements(ElementFilter) IList<ElementId> Get all elements that, from a logical point of view, are the children of this Element. (Inherited from 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. (Inherited from Element .) Element
M GetEntitySchemaGuids() IList<Guid> Returns the Schema guids of any Entities stored in this element. (Inherited from Element .) Element
M GetExternalFileReference() ExternalFileReference Gets information pertaining to the external file referenced by the element. (Inherited from Element .) Element
M GetExternalResourceReference(ExternalResourceType) ExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element .) Element
M GetExternalResourceReferences() IDictionary Gets the full map of the external resource references referenced by the element. (Inherited from Element .) Element
M GetFamilyPointPlacementReferences() IList<FamilyPointPlacementReference> Returns the Point Placement References for the Family Instance.
M GetGeneratingElementIds(GeometryObject) ICollection<ElementId> Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element .) Element
M GetGeometryObjectFromReference(Reference) GeometryObject Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element .) Element
M GetHashCode None (Inherited from Object .) Object .
M GetMaterialArea(ElementId, Boolean) double Gets the area of the material with the given id. (Inherited from Element .) Element
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. (Inherited from Element .) Element
M GetMaterialVolume(ElementId) double Gets the volume of the material with the given id. (Inherited from Element .) Element
M GetMonitoredLinkElementIds() IList<ElementId> Provides the link instance IDs when the element is monitoring. (Inherited from Element .) Element
M GetMonitoredLocalElementIds() IList<ElementId> Provides the local element IDs when the element is monitoring. (Inherited from Element .) Element
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. (Inherited from Element .) Element
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 GetParameterFormatOptions(ElementId) FormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element .) Element
M GetParameters(String) IList<Parameter> Retrieves the parameters from the element via the given name. (Inherited from Element .) Element
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element .) Element
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 GetSubelements() IList<Subelement> Returns the collection of element subelements. (Inherited from Element .) Element
M GetSweptProfile() A swept profile. Gets the object that describes the profile that is swept along the driving curve for this instance.
M GetTotalTransform() Transform Gets the total transform, which includes the true north transform for instances like import instances. (Inherited from Instance .) Instance
M GetTransform() The inherent transform. Gets the transform of the instance. (Inherited from Instance .) Instance
M GetType None (Inherited from Object .) Object .
M GetTypeId() ElementId Returns the identifier of this element's type. (Inherited from Element .) Element
M GetValidTypes.() ICollection<ElementId> Obtains a set of types that are valid for this element. (Inherited from Element .) Element
M HasModifiedGeometry() bool Identifies if the geometry of this FamilyInstance has been modified from the automatically generated default.
M HasPhases() bool Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element .) Element
M HasSweptProfile() bool Indicates if this instance can be represented as a swept profile.
M IsExternalFileReference() bool Determines whether this Element represents an external file. (Inherited from Element .) Element
M IsHidden(View) bool Identifies if the element has been permanently hidden in the view. (Inherited from Element .) Element
M IsMonitoringLinkElement() bool Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element .) Element
M IsMonitoringLocalElement() bool Indicate whether an element is monitoring other local elements. (Inherited from Element .) Element
M IsPhaseCreatedValid(ElementId) bool Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element .) Element
M IsPhaseDemolishedValid(ElementId) bool Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element .) Element
M IsValidType(ElementId) bool Checks if given type is valid for this element. (Inherited from Element .) Element
M LookupParameter(String) nullNothingnullptr Attempts to find a parameter on the element which has the given name. (Inherited from Element .) Element
M RefersToExternalResourceReference(ExternalResourceType) bool Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element .) Element
M RefersToExternalResourceReferences() bool Determines whether this Element uses external resources. (Inherited from Element .) Element
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 SetEntity(Entity) None Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element .) Element
M Split(Double) ElementId Splits the family instance element at a point on its defining curve.
M ToString None (Inherited from Object .) Object .
Name Return Type Description Inherited From
P AssemblyInstanceId ElementId The id of the assembly instance to which the element belongs. (Inherited from Element .) Element
P BoundingBox BoundingBoxXYZ Retrieves a box that circumscribes all geometry of the element. (Inherited from Element .) Element
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 Split(Double) ).
P Category Category Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element .) Element
P CreatedPhaseId ElementId Id of a Phase at which the Element was created. (Inherited from Element .) Element
P DemolishedPhaseId ElementId Id of a Phase at which the Element was demolished. (Inherited from Element .) Element
P DesignOption DesignOption Returns the design option to which the element belongs. (Inherited from Element .) Element
P Document Document Returns the Document in which the Element resides. (Inherited from Element .) Element
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.Phase. Room
P Geometry GeometryElement Retrieves the geometric representation of the element. (Inherited from Element .) Element
P GroupId ElementId The id of the group to which an element belongs. (Inherited from Element .) Element
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 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 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 Id ElementId A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element .) Element
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 IsTransient bool Indicates whether an element is transient or permanent. (Inherited from Element .) Element
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element .) Element
P IsWorkPlaneFlipped bool Identifies if the instance's work plane is flipped.
P LevelId ElementId The id of the level associated with the element. (Inherited from Element .) Element
P Location Location This property is used to find the physical location of an instance within project. (Overrides Element . Location .)
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 Name string A human readable name for the Element. (Inherited from Element .) Element
P OwnerViewId ElementId The id of the view that owns the element. (Inherited from Element .) Element
P Parameter.Guid. Parameter Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element .) Element
P Parameter.BuiltInParameter. Parameter Retrieves a parameter from the element given a parameter id. (Inherited from Element .) Element
P Parameter.Definition. Parameter Retrieves a parameter from the element based on its definition. (Inherited from Element .) Element
P Parameters ParameterSet Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P ParametersMap ParameterMap Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P Pinned bool Identifies if the element has been pinned to prevent changes. (Inherited from Element .) Element
P Room Room The room in which the instance is located (during the last phase of the project).
P Room.Phase. Room
P Space Space The space in which the instance is located (during the last phase of the project).
P Space.Phase. 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.Phase. Room
P UniqueId string A stable unique identifier for an element within the document. (Inherited from Element .) Element
P VersionGuid Guid Get the element version Guid. (Inherited from Element .) Element
P ViewSpecific bool Identifies if the element is owned by a view. (Inherited from Element .) Element
P WorksetId WorksetId Get Id of the Workset which owns the element. (Inherited from Element .) Element