FamilyManager.AddParameter
Description:
Add a new family parameter with a given name.
Add a new family parameter with a given name.
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. To add a parameter of family type use the AddParameter overload that accepts a category instead.
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. To add a parameter of family type use the AddParameter overload that accepts a category instead.
Overloads (5):
AddParameter(String,ForgeTypeId,ForgeTypeId,Boolean)
public FamilyParameter AddParameter(
string parameterName,
ForgeTypeId groupTypeId,
ForgeTypeId specTypeId,
bool isInstance
)
-
StringparameterNameThe name of the new family parameter.
-
groupTypeIdThe identifier of the new family parameter's parameter group.
-
specTypeIdThe type of new family parameter.
-
BooleanisInstanceIndicates 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.
-
Thrown when the input argument-"parameterName"-isnullNothingnullptra null reference (Nothingin Visual Basic).
-
Thrown when the input argument-"parameterName"-is already in use, or when the input argument -"specTypeId" is an invalid type, or the input parameter group cannot be assigned to the new parameter.
-
Thrown when the family parameter creation failed. Or trying to add an instance parameter of image type.