RenameParameter Method


Rename a family parameter.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)

Syntax

C#
public void RenameParameter(
	FamilyParameter familyParameter,
	string name
)
Visual Basic
Public Sub RenameParameter ( _
	familyParameter As FamilyParameter, _
	name As String _
)
Visual C++
public:
void RenameParameter(
	FamilyParameter^ familyParameter, 
	String^ name
)

Parameters

familyParameter
Type: Autodesk.Revit.DBFamilyParameter
The family parameter.
name
Type: SystemString
The new name.

Remarks

This operation is valid only for Family Parameters, and is invalid for Shared Parameters and Built-in Parameters.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentNullException Thrown when the input argument-"familyParameter" or "name"-is a null reference (Nothing in Visual Basic).
Autodesk.Revit.ExceptionsArgumentException Thrown when the input argument-"familyParameter"-is invalid, or the input name string contains illegal characters, or duplicated with existing parameter name.
Autodesk.Revit.ExceptionsInvalidOperationException Thrown when trying to rename a built-in parameter or shared parameter.

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →