•  

AddParameter Method (ExternalDefinition, ForgeTypeId, Boolean)

Add a new shared parameter to the family.

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

Syntax

C# 
public FamilyParameter AddParameter(
	ExternalDefinition familyDefinition,
	ForgeTypeId groupTypeId,
	bool isInstance
)
Visual Basic 
Public Function AddParameter ( _
	familyDefinition As ExternalDefinition, _
	groupTypeId As ForgeTypeId, _
	isInstance As Boolean _
) As FamilyParameter
Visual C++ 
public:
FamilyParameter^ AddParameter(
	ExternalDefinition^ familyDefinition, 
	ForgeTypeId^ groupTypeId, 
	bool isInstance
)

Parameters

familyDefinition
Type: Autodesk.Revit.DB ExternalDefinition
The definition of the loaded shared parameter.
groupTypeId
Type: Autodesk.Revit.DB ForgeTypeId
The identifier of the parameter group to which the family parameter belongs.
isInstance
Type: System Boolean
Indicates if the new parameter is instance or type.

Return Value

If creation was successful the new shared parameter is returned, otherwise an exception with failure information will be thrown.

Remarks

This method can work even without any family type, but it cannot be assigned the value via FamilyManager.Set methods when there is no current type.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException Thrown when the input parameter group cannot be assigned to the new parameter.
Autodesk.Revit.Exceptions InvalidOperationException Thrown when the shared family parameter creation is not supported. Or trying to add an instance parameter of image type.

See Also