FamilyManager
The family manager object to manage the family types and parameters in family document.
SystemObject
Autodesk.Revit.DBAPIObject
Autodesk.Revit.DBFamilyManager
**Namespace:**Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
public class FamilyManager : APIObject
Public Class FamilyManager Inherits APIObject
public ref class FamilyManager : public APIObject
type FamilyManager = class inherit APIObject end
The FamilyManager type exposes the following members. Name
Description
Public Property
CurrentType
The current family type.
Public Property
Code Example
IsReadOnly
Identifies if the object is read-only or modifiable.
(Inherited from APIObject)
Public Property
ParameterBuiltInParameter
Obtains the parameter of this type with a given parameter id.
Public Property
ParameterDefinition
Obtains the parameter of this type with a given definition.
Public Property
ParameterGuid
Obtains the parameter of this type with a given GUID for a shared parameter.
Public Property
ParameterString
Obtains the parameter of this type with a given name.
Public Property
Parameters
All family parameters in this family.
Public Property
Code Example
Types
All family types in the family.
Name
Description
Public Method
AddParameter(ExternalDefinition, ForgeTypeId, Boolean)
Add a new shared parameter to the family.
Public Method
AddParameter(String, ForgeTypeId, Category, Boolean)
Add a new family type parameter to control the type of a nested family within another family.
Public Method
AddParameter(String, ForgeTypeId, ForgeTypeId, Boolean)
Add a new family parameter with a given name.
Public Method
AssociateElementParameterToFamilyParameter
Associates or disassociates the element parameter to an existing family parameter.
Public Method
CanElementParameterBeAssociated
Indicates if this element parameter can be associated with a family parameter.
Public Method
DeleteCurrentType
Remove the current family type.
Public Method
Dispose
Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject)
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object)
Public Method
GetAssociatedFamilyParameter
Gets the associated family parameter of an element parameter.
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object)
Public Method
GetParameter
Obtains the family parameter with the given built-in parameter identifier.
Public Method
GetParameters
Gets the parameters associated to family types in order.
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
IsParameterLockable
For Conceptual Mass and Curtain Panel families, indicate whether the specified parameter can be locked.
Public Method
IsParameterLocked
For Conceptual Mass and Curtain Panel families, indicate whether the specified dimension-driving parameter is locked.
Public Method
IsUserAssignableParameterGroup
Checks if the given parameter group can be assigned to new parameters.
Public Method
MakeInstance
Set the family parameter as an instance parameter.
Public Method
MakeNonReporting
Set the reporting family parameter as a regular/driving parameter.
Public Method
MakeReporting
Set the family parameter as a reporting parameter.
Public Method
MakeType
Set the family parameter as a type parameter.
Public Method
Code Example
NewType
Add a new family type with a given name and makes it be the current type.
Public Method
RemoveParameter
Remove an existing family parameter from the family.
Public Method
RenameCurrentType
Rename the current family type.
Public Method
RenameParameter
Rename a family parameter.
Public Method
ReorderParameters
Reorders the family parameters by the specified parameters order.
Public Method
ReplaceParameter(FamilyParameter, ExternalDefinition, ForgeTypeId, Boolean)
Replace a family parameter with a shared parameter.
Public Method
ReplaceParameter(FamilyParameter, String, ForgeTypeId, Boolean)
Replace a shared family parameter with a new non-shared family parameter.
Public Method
Set(FamilyParameter, ElementId)
Set the ElementId value of a family parameter of the current family type.
Public Method
Set(FamilyParameter, Double)
Set the double value of a family parameter of the current family type.
Public Method
Set(FamilyParameter, Int32)
Set the integer value of a family parameter of the current family type.
Public Method
Set(FamilyParameter, String)
Set the string value of a family parameter of the current family type.
Public Method
SetDescription
Set the description for an existing family parameter. The description will be used as tooltip in the Revit UI including in the properties palette.
Public Method
SetFormula
Set the formula of a family parameter.
Public Method
SetParameterLocked
For Conceptual Mass and Curtain Panel families, lock or unlock a dimension-driving parameter.
Public Method
SetValueString
Set the string value of a family parameter of the current family type.
Public Method
Code Example
SortParameters
Sorts the family parameters according to the desired sort order.
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)