GlobalParameter.CanLabelDimension
Method
Description:
Tests whether a dimension can be labeled by the global parameter.
Tests whether a dimension can be labeled by the global parameter.
Remarks:
Possible causes include a dimension that cannot be labeled at all, or it is of other than Linear or Angular type, or does not have the appropriate labeling parameter. Another reason for this method returning False is that the data type of this global parameter is not suitable for labeling (i.e. it contains neither Length nor Angle value), or the parameter is reporting and the dimension has more than one segment.
Possible causes include a dimension that cannot be labeled at all, or it is of other than Linear or Angular type, or does not have the appropriate labeling parameter. Another reason for this method returning False is that the data type of this global parameter is not suitable for labeling (i.e. it contains neither Length nor Angle value), or the parameter is reporting and the dimension has more than one segment.
Parameters
| Parameter | Type | Description |
|---|---|---|
| dimensionId | ElementId | Id of a dimension element. |
Return Value
| Type | Description |
|---|---|
| Boolean | True of the input dimension can be labeled by this global parameter; False oterwise. |
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | A non-optional argument was null |