FamilyManager.ReplaceParameter
Description:
Replace a family parameter with a shared parameter.
Replace a family parameter with a shared parameter.
Remarks:
This operation is invalid for Built-in Parameters. The formulas and labels which in reference to this parameter will be updated to the new parameter.
This operation is invalid for Built-in Parameters. The formulas and labels which in reference to this parameter will be updated to the new parameter.
Overloads (4):
ReplaceParameter(FamilyParameter,ExternalDefinition,BuiltInParameterGroup,Boolean)
[ObsoleteAttribute("This method is deprecated in Revit 2024 and may be removed in a future version of Revit. Please use the `ReplaceParameter(FamilyParameter, ExternalDefinition, ForgeTypeId, bool)` method instead.")]
public FamilyParameter ReplaceParameter(
FamilyParameter currentParameter,
ExternalDefinition familyDefinition,
BuiltInParameterGroup parameterGroup,
bool isInstance
)-
currentParameterThe current family parameter.
-
familyDefinitionThe definition of the loaded shared parameter.
-
parameterGroupThe group to which the new shared parameter belongs.
-
BooleanisInstanceIndicates if the new parameter is instance or type.
Return Value
FamilyParameter
If replacement was successful the new shared parameter is returned,
otherwise an exception with failure information will be thrown.
-
Thrown when the input argument-"familyParameter" or "name"-isnullNothingnullptra null reference (Nothingin Visual Basic).
-
Thrown when the input argument-"familyParameter"-is invalid, or the input parameter group cannot be assigned to the new parameter, or the input name string contains illegal characters, or duplicated with existing parameter name.
-
Thrown when trying to replace a built-in parameter.
-
Thrown when replacement failed, because the replacement would cause a formula error. Or trying to replace with an instance parameter of image type.