•  

IsCyclical Method

True if the array doesn't have finite bounds in the given dimension. Cyclical bounds indicate that the array forms a closed loop in the given dimension.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 2015.0.0.0 (2015.0.0.0)
Since: 2014

Syntax

C# 
public bool IsCyclical(
	int dimension
)
Visual Basic 
Public Function IsCyclical ( _
	dimension As Integer _
) As Boolean
Visual C++ 
public:
bool IsCyclical(
	int dimension
)

Parameters

dimension
Type: System Int32
The dimension.

Return Value

True if the bounds are cyclical in the given dimension.

Remarks

The dimension begins at 0 and must be in the range [0, number of dimensions in the bounds - 1]. This method does not apply to zero dimensional bounds.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException The dimension is invalid for these bounds.
Autodesk.Revit.Exceptions InvalidOperationException The bounds must have at least one dimension.

See Also