FamilyManager Members


The FamilyManager type exposes the following members.

Methods

  NameDescription
Public methodAddParameter(ExternalDefinition, BuiltInParameterGroup, Boolean) Obsolete.
Add a new shared parameter to the family.
Public methodAddParameter(ExternalDefinition, ForgeTypeId, Boolean)
Add a new shared parameter to the family.
Public methodAddParameter(String, BuiltInParameterGroup, Category, Boolean) Obsolete.
Add a new family type parameter to control the type of a nested family within another family.
Public methodAddParameter(String, ForgeTypeId, Category, Boolean)
Add a new family type parameter to control the type of a nested family within another family.
Public methodAddParameter(String, ForgeTypeId, ForgeTypeId, Boolean)
Add a new family parameter with a given name.
Public methodAssociateElementParameterToFamilyParameter
Associates or disassociates the element parameter to an existing family parameter.
Public methodCanElementParameterBeAssociated
Indicates if this element parameter can be associated with a family parameter.
Public methodDeleteCurrentType
Remove the current family type.
Public methodDispose
Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAssociatedFamilyParameter
Gets the associated family parameter of an element parameter.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetParameter
Obtains the family parameter with the given built-in parameter identifier.
Public methodGetParameters
Gets the parameters associated to family types in order.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsParameterLockable
For Conceptual Mass and Curtain Panel families, indicate whether the specified parameter can be locked.
Public methodIsParameterLocked
For Conceptual Mass and Curtain Panel families, indicate whether the specified dimension-driving parameter is locked.
Public methodIsUserAssignableParameterGroup(BuiltInParameterGroup) Obsolete.
Checks if the given parameter group can be assigned to new parameters.
Public methodIsUserAssignableParameterGroup(ForgeTypeId)
Checks if the given parameter group can be assigned to new parameters.
Public methodMakeInstance
Set the family parameter as an instance parameter.
Public methodMakeNonReporting
Set the reporting family parameter as a regular/driving parameter.
Public methodMakeReporting
Set the family parameter as a reporting parameter.
Public methodMakeType
Set the family parameter as a type parameter.
Public methodNewType
Add a new family type with a given name and makes it be the current type.
Public methodRemoveParameter
Remove an existing family parameter from the family.
Public methodRenameCurrentType
Rename the current family type.
Public methodRenameParameter
Rename a family parameter.
Public methodReorderParameters
Reorders the family parameters by the specified parameters order.
Public methodReplaceParameter(FamilyParameter, ExternalDefinition, BuiltInParameterGroup, Boolean) Obsolete.
Replace a family parameter with a shared parameter.
Public methodReplaceParameter(FamilyParameter, ExternalDefinition, ForgeTypeId, Boolean)
Replace a family parameter with a shared parameter.
Public methodReplaceParameter(FamilyParameter, String, BuiltInParameterGroup, Boolean) Obsolete.
Replace a shared family parameter with a new non-shared family parameter.
Public methodReplaceParameter(FamilyParameter, String, ForgeTypeId, Boolean)
Replace a shared family parameter with a new non-shared family parameter.
Public methodSet(FamilyParameter, ElementId)
Set the ElementId value of a family parameter of the current family type.
Public methodSet(FamilyParameter, Double)
Set the double value of a family parameter of the current family type.
Public methodSet(FamilyParameter, Int32)
Set the integer value of a family parameter of the current family type.
Public methodSet(FamilyParameter, String)
Set the string value of a family parameter of the current family type.
Public methodSetDescription
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 methodSetFormula
Set the formula of a family parameter.
Public methodSetParameterLocked
For Conceptual Mass and Curtain Panel families, lock or unlock a dimension-driving parameter.
Public methodSetValueString
Set the string value of a family parameter of the current family type.
Public methodSortParameters
Sorts the family parameters according to the desired sort order.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties

  NameDescription
Public propertyCurrentType
The current family type.
Public propertyIsReadOnly
Identifies if the object is read-only or modifiable.
(Inherited from APIObject.)
Public propertyParameterGuid
Obtains the parameter of this type with a given GUID for a shared parameter.
Public propertyParameterString
Obtains the parameter of this type with a given name.
Public propertyParameterBuiltInParameter
Obtains the parameter of this type with a given parameter id.
Public propertyParameterDefinition
Obtains the parameter of this type with a given definition.
Public propertyParameters
All family parameters in this family.
Public propertyTypes
All family types in the family.

See Also