CompoundStructure.ChangeRegionWidth
Method
Description:
Adjust the width of an existing simple region.
Adjust the width of an existing simple region.
Remarks:
If width is changed to zero, the effect is to delete the region.
If width is changed to zero, the effect is to delete the region.
Parameters
Parameter | Type | Description |
---|---|---|
regionId | Int32 | The id of a region. |
newWidth | Double | The desired width of the specified region. |
Return Value
Type | Description |
---|---|
Boolean | True if newWidth is zero and the region was deleted. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | It is not a valid region id. -or- It is not a simple region. |
InvalidOperationException | This operation is valid only for vertically compound structures. |