•  

GetSegmentHeight Method

Gets the segment height.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2022.1

Syntax

C#
public double GetSegmentHeight(
	int segmentIndex
)
Visual Basic
Public Function GetSegmentHeight ( _
	segmentIndex As Integer _
) As Double
Visual C++
public:
double GetSegmentHeight(
	int segmentIndex
)

Parameters

segmentIndex
Type: SystemInt32
Zero-based index of the segment.

Return Value

The segment height value.

Remarks

The height is Revit's internal units value of schedule header and segment body. The real height of segment on sheet may be less than the segment height get here. It is the border height of segment instance on sheet. The last segment height get here is the max value of double as the last segment height is not set to a fix value. It will be determined by whole schedule height and other segments' heights. And the border for it is max value of double.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentException The segment index should start from 0 and be less than the total segment count.

See Also