FamilyManager.AddParameter(String, ForgeTypeId, Category, Boolean)

Public Class

Add a new family type parameter to control the type of a nested family within another family.

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

Syntax

public FamilyParameter AddParameter(
  string parameterName,
  ForgeTypeId groupTypeId,
  Category familyCategory,
  bool isInstance
)

Parameters

parameterNameString

The name of the new family parameter.

groupTypeId ForgeTypeId

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

familyCategory Category

The category to which the new family parameter binds.

isInstanceBoolean

Indicates if the new family parameter is instance or type.

Return Value

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

Exceptions

Exception

Condition

ArgumentNullException

Thrown when the input argument-”parameterName”-is ..

ArgumentException

Thrown when the input argument-”parameterName”-is already in use, or the input parameter group cannot be assigned to the new parameter, or the input argument-”familyCategory”-is illegal to bind with parameter.

InvalidOperationException

Thrown when the required family of familyCategory is not existing in current document, , or when the creation failed. 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.