Revit 2025.3 API
Family |
An element that represents a single type with a Family.
Inheritance HierarchySystemObject
Autodesk.Revit.DBElement
Autodesk.Revit.DBElementType
Autodesk.Revit.DBInsertableObject
Autodesk.Revit.DBFamilySymbol
More
Autodesk.Revit.DBElement
Autodesk.Revit.DBElementType
Autodesk.Revit.DBInsertableObject
Autodesk.Revit.DBFamilySymbol
More
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
The FamilySymbol 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) |
| CanBeCopied |
Determine if this ElementType can create a copy
(Inherited from ElementType) |
| CanBeDeleted |
Determine if this ElementType can be deleted
(Inherited from ElementType) |
| CanBeRenamed |
Determine if this ElementType can be renamed
(Inherited from ElementType) |
| 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) |
| Family | The Family object to which the symbol belongs. |
| FamilyName |
Gets the family name of this element type.
(Inherited from ElementType) |
| 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) |
| Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element) |
| IsActive | Identifies whether the symbol is active. |
| IsModifiable |
Identifies if the element is modifiable.
(Inherited from Element) |
| 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) |
| 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 element within a project. (Inherited from Element) |
| Name | Set the name for the ElementType. (Inherited from ElementType) |
| 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) |
| StructuralMaterialType | This property returns the physical material from which the type is made. |
| 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 | |
|---|---|---|
 | Activate | Activates the symbol to ensure that its geometry is accessible. |
| 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) |
| CanHaveStructuralSection | Identifies if this FamilySymbol can have a structural section. |
| 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) |
| Duplicate |
Duplicates an existing element type and assigns it a new name.
(Inherited from ElementType) |
| 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) |
| 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) |
| GetFamilyPointLocations | Returns the Point Locations for the Family Symbol. |
| 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) |
| 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) |
| GetPreviewImage | Get the preview image of an element. This image is similar to what is seen in the Revit UI when selecting the type of an element. (Inherited from ElementType) |
| GetSimilarTypes |
Obtains a set of types that are similar to this type.
(Inherited from ElementType) |
| GetStructuralSection | Gets the structural section from element. |
| GetSubelements |
Returns the collection of element subelements.
(Inherited from Element) |
| GetThermalProperties | Gets the thermal properties for the given FamilySymbol. |
| 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) |
| HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element) |
| HasThermalProperties | Identifies if this FamilySymbol can include thermal properties. |
| 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) |
| IsSimilarType |
Checks if given type is similar to this type.
(Inherited from ElementType) |
| IsValidDefaultFamilyType |
Identifies if this type is a valid default family type for the given family category id.
(Inherited from ElementType) |
| 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) |
| SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from Element) |
| SetStructuralSection | Sets the structural section in element. |
| SetThermalProperties | Sets the thermal properties for the given FamilySymbol. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Remarks
Custom families within the Revit API represented by three objects - Family, FamilySymbol
and FamilyInstance.
Each object plays a significant part in the structure of families. The Family element represents the entire family
that consists of a collection of types, such as an 'I Beam'. You can think of that object as representing the entire
family file. The Family object contains a number of FamilySymbol elements. The
FamilySymbol object represents a specific set
of family settings within that Family and represents what is known in the Revit user interface as a
Type, such as 'W14x32'. The FamilyInstance object represents an actual instance of that
type placed the Autodesk Revit project. For example the FamilyInstance would
be a single instance of a W14x32 column within the project.
See Also
Reference
Inheritance HierarchySystemObject
Autodesk.Revit.DBElement
Autodesk.Revit.DBElementType
Autodesk.Revit.DBInsertableObject
Autodesk.Revit.DBFamilySymbol
Autodesk.Revit.DBAnnotationSymbolType
Autodesk.Revit.DB.ArchitectureRoomTagType
Autodesk.Revit.DBAreaTagType
Autodesk.Revit.DB.MechanicalSpaceTagType
Autodesk.Revit.DBMullionType
Autodesk.Revit.DBPanelType
Autodesk.Revit.DB.StructureTrussType
Autodesk.Revit.DBElement
Autodesk.Revit.DBElementType
Autodesk.Revit.DBInsertableObject
Autodesk.Revit.DBFamilySymbol
Autodesk.Revit.DBAnnotationSymbolType
Autodesk.Revit.DB.ArchitectureRoomTagType
Autodesk.Revit.DBAreaTagType
Autodesk.Revit.DB.MechanicalSpaceTagType
Autodesk.Revit.DBMullionType
Autodesk.Revit.DBPanelType
Autodesk.Revit.DB.StructureTrussType