FamilyManager.AddParameter(ExternalDefinition, ForgeTypeId, Boolean)
Method
Description:
Add a new shared parameter to the family.
Add a new shared parameter to the family.
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.
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.
Syntax
public FamilyParameter AddParameter(
ExternalDefinition familyDefinition,
ForgeTypeId groupTypeId,
bool isInstance
)
Parameters
Parameter | Type | Description |
---|---|---|
familyDefinition | ExternalDefinition | The definition of the loaded shared parameter. |
groupTypeId | ForgeTypeId | The identifier of the parameter group to which the family parameter belongs. |
isInstance | Boolean | Indicates if the new parameter is instance or type. |
Return Value
Type | Description |
---|---|
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. |