FamilyManager
Description:
The family manager object to manage the family types and parameters in family document.
The family manager object to manage the family types and parameters in family document.
public class FamilyManager : APIObject| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AddParameter(ExternalDefinition, BuiltInParameterGroup, Boolean) | FamilyParameter | Add a new shared parameter to the family. | |
| AddParameter(String, BuiltInParameterGroup, Category, Boolean) | FamilyParameter | Add a new family type parameter to control the type of a nested family within another family. | |
| AddParameter(String, BuiltInParameterGroup, ParameterType, Boolean) | FamilyParameter | Add a new family parameter with a given name. | |
| AssociateElementParameterToFamilyParameter(Parameter, FamilyParameter) | None | Associates or disassociates the element parameter to an existing family parameter. | |
| CanElementParameterBeAssociated(Parameter) | bool | Indicates if this element parameter can be associated with a family parameter. | |
| DeleteCurrentType() | None | Remove the current family type. | |
| GetAssociatedFamilyParameter(Parameter) | nullNothingnullptr | Gets the associated family parameter of an element parameter. | |
| GetParameters() | IList<FamilyParameter> | Gets the parameters associated to family types in order. | |
| IsParameterLockable(FamilyParameter) | bool | For Conceptual Mass and Curtain Panel families, indicate whether the specified parameter can be locked. | |
| IsParameterLocked(FamilyParameter) | bool | For Conceptual Mass and Curtain Panel families, indicate whether the specified dimension-driving parameter is locked. | |
| IsUserAssignableParameterGroup(BuiltInParameterGroup) | bool | Checks if the given parameter group can be assigned to new parameters. | |
| MakeInstance(FamilyParameter) | None | Set the family parameter as an instance parameter. | |
| MakeNonReporting(FamilyParameter) | None | Set the reporting family parameter as a regular/driving parameter. | |
| MakeReporting(FamilyParameter) | None | Set the family parameter as a reporting parameter. | |
| MakeType(FamilyParameter) | None | Set the family parameter as a type parameter. | |
| NewType(String) | FamilyType | Add a new family type with a given name and makes it be the current type. | |
| RemoveParameter(FamilyParameter) | None | Remove an existing family parameter from the family. | |
| RenameCurrentType(String) | None | Rename the current family type. | |
| RenameParameter(FamilyParameter, String) | None | Rename a family parameter. | |
| ReorderParameters(IList<FamilyParameter>) | None | Reorders the family parameters by the specified parameters order. | |
| ReplaceParameter(FamilyParameter, ExternalDefinition, BuiltInParameterGroup, Boolean) | FamilyParameter | Replace a family parameter with a shared parameter. | |
| ReplaceParameter(FamilyParameter, String, BuiltInParameterGroup, Boolean) | FamilyParameter | Replace a shared family parameter with a new non-shared family parameter. | |
| SetDescription(FamilyParameter, String) | None | Set the description for an existing family parameter. The description will be used as tooltip in the Revit UI including in the properties palette. | |
| SetFormula(FamilyParameter, String) | None | Set the formula of a family parameter. | |
| Set(FamilyParameter, Double) | None | Set the double value of a family parameter of the current family type. | |
| Set(FamilyParameter, ElementId) | None | Set the ElementId value of a family parameter of the current family type. | |
| Set(FamilyParameter, Int32) | None | Set the integer value of a family parameter of the current family type. | |
| Set(FamilyParameter, String) | None | Set the string value of a family parameter of the current family type. | |
| SetParameterLocked(FamilyParameter, Boolean) | None | For Conceptual Mass and Curtain Panel families, lock or unlock a dimension-driving parameter. | |
| SetValueString(FamilyParameter, String) | None | Set the string value of a family parameter of the current family type. | |
| SortParameters(ParametersOrder) | None | Sorts the family parameters according to the desired sort order. | |
| Dispose() | None | Causes the object to release immediately any resources it may be utilizing. | APIObject |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| CurrentType | FamilyType | The current family type. | |
| Parameter | FamilyParameter | Obtains the parameter of this type with a given parameter id. | |
| Parameter | FamilyParameter | Obtains the parameter of this type with a given definition. | |
| Parameter | FamilyParameter | Obtains the parameter of this type with a given GUID for a shared parameter. | |
| Parameter | FamilyParameter | Obtains the parameter of this type with a given name. | |
| Parameters | FamilyParameterSet | All family parameters in this family. | |
| Types | FamilyTypeSet | All family types in the family. | |
| IsReadOnly | bool | Identifies if the object is read-only or modifiable. | APIObject |