GetIteration, ScriptGetIteration Methods

Applies To

fpSpread control

Description

Returns the number of iterations for circular references.

Syntax

C++

BOOL CSpreadSheet::GetIteration (short* MaxIterations, double* MaxChange);

Visual Basic

fpSpread.GetIteration(MaxIterations As Integer, MaxChange As Double) As Boolean

Note: The ScriptGetIteration method uses the same syntax except method parameters that are not passed "ByVal" are declared as variants. For more information on Script methods, see Scripting Environment Usage.

Parameters

The following parameters are available:

Parameter	Description
MaxIterations	Maximum number of iterations
MaxChange	(Future use)

Remarks

The GetIteration method returns iteration options for circular references in formulas. A circular reference occurs when a formula in a cell refers to its own cell. For example, the formula (A1*B1) is circular if it is in cell A1.

This method is applied to the entire workbook, including all sheets in the control.

The iteration process stops after the number of iterations returned by the MaxIterations parameter.

Note: Call this method if you use the Spread control in a scripting environment (for example, Microsoft's Visual InterDev or Internet Explorer) or a non-scripting environment. However, if you want to use the Spread control in a scripting environment and you want to change any parameter that is not passed "ByVal", you must set the ScriptEnhanced property to True and call the ScriptGetIteration method. ScriptGetIteration method parameters that are not passed "ByVal" are declared as variants.

Return Type

True if recursive formulas are being evaluated; otherwise, False.

DLL Correspondence

SSGetIteration function