SpreadsheetGear 2023
GetArrayFormulaInfo Method (IArguments)


SpreadsheetGear.CustomFunctions Namespace > IArguments Interface : GetArrayFormulaInfo Method
Will be set to the zero based upper row of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.
Will be set to the zero based left column of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.
Will be set to the zero based lower row of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.
Will be set to the zero based right column of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.
Returns true and sets row1, col1, row2 and col2 to the zero based upper-left and lower-right row and column indexes of the array formula if the formula currently being evaluated is an array formula, or returns false and leaves the parameters unchanged if the formula currently being evaluated is not an array formula.
Syntax
'Declaration
 
Function GetArrayFormulaInfo( _
   ByRef row1 As System.Integer, _
   ByRef col1 As System.Integer, _
   ByRef row2 As System.Integer, _
   ByRef col2 As System.Integer _
) As System.Boolean
'Usage
 
Dim instance As IArguments
Dim row1 As System.Integer
Dim col1 As System.Integer
Dim row2 As System.Integer
Dim col2 As System.Integer
Dim value As System.Boolean
 
value = instance.GetArrayFormulaInfo(row1, col1, row2, col2)
System.bool GetArrayFormulaInfo( 
   ref System.int row1,
   ref System.int col1,
   ref System.int row2,
   ref System.int col2
)

Parameters

row1
Will be set to the zero based upper row of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.
col1
Will be set to the zero based left column of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.
row2
Will be set to the zero based lower row of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.
col2
Will be set to the zero based right column of the array formula currently being evaluated, or left unchanged if the formula currently being evaluated is not an array formula.

Return Value

true if the formula currently being evaluated is an array formula, or false if the formula currently being evaluated is not an array formula.
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

IArguments Interface
IArguments Members