FamilyManager.AddParameter(ExternalDefinition, ForgeTypeId, Boolean)

Public Class

Add a new shared parameter to the family.

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public FamilyParameter AddParameter(
  ExternalDefinition familyDefinition,
  ForgeTypeId groupTypeId,
  bool isInstance
)

Parameters

familyDefinition ExternalDefinition

The definition of the loaded shared parameter.

groupTypeId ForgeTypeId

The identifier of the parameter group to which the family parameter belongs.

isInstanceBoolean

Indicates if the new parameter is instance or type.

Return Value

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

Exceptions

Exception

Condition

---

ArgumentException

Thrown when the input parameter group cannot be assigned to the new parameter.

---

InvalidOperationException

Thrown when the shared family parameter creation is not supported. Or trying to add an instance parameter of image type.

---

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.