FamilyParameter
Description:
The family parameter object.
The family parameter object.
public class FamilyParameter : APIObject
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| Dispose() | None | Causes the object to release immediately any resources it may be utilizing. (Inherited from APIObject ) | APIObject |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GetUnitTypeId() | ForgeTypeId | Gets the identifier of the unit quantifying the parameter value. | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AssociatedParameters | ParameterSet | The parameters from elements in the family which are associated to this parameter. | |
| CanAssignFormula | bool | Indicates if this parameter can be assigned a formula. | |
| Definition | Definition | The definition. | |
| Formula | string | The formula. | |
| GUID | Guid | The globally unique identifier | |
| Id | ElementId | The id of the family parameter. | |
| IsDeterminedByFormula | bool | Indicates if the parameter is determined by formula. | |
| IsInstance | bool | Indicates if the parameter is instance or type. | |
| IsReadOnly | bool | Identifies if the object is read-only or modifiable. (Overrides APIObject . IsReadOnly ) | |
| IsReporting | bool | Indicates if the parameter is a reporting parameter. | |
| IsShared | bool | Identifies if the parameter is a shared parameter. | |
| StorageType | StorageType | The storage type describes the type that is used internally within the parameter to store its value. | |
| UserModifiable | bool | Indicates whether the interactive user can modify the value of this parameter. |