set_dynamic_array_formula method

set_dynamic_array_formula

Sets dynamic array formula and make the formula spill into neighboring cells if possible.

Returns

the range that the formula should spill into.

def set_dynamic_array_formula(self, array_formula, options, calculate_value):
    ...
ParameterTypeDescription
array_formulastrthe formula expression
optionsFormulaParseOptionsoptions to parse formula.
“Parse” option will be ignored and the formula will always be parsed immediately
calculate_valueboolwhether calculate this dynamic array formula for those cells in the spilled range.

Remarks

the returned range may be not same with the actual one that this dynamic array formula spills into. If there are non-empty cells in the range, the formula will be set for current cell only and marked as “#SPILL!”. But for such kind of situation we still return the whole range that this formula should spill into.

set_dynamic_array_formula

Sets dynamic array formula and make the formula spill into neighboring cells if possible.

Returns

the range that the formula should spill into.

def set_dynamic_array_formula(self, array_formula, options, values, calculate_range, calculate_value):
    ...
ParameterTypeDescription
array_formulastrthe formula expression
optionsFormulaParseOptionsoptions to parse formula.
“Parse” option will be ignored and the formula will always be parsed immediately
valueslistvalues(calculated results) for those cells with given dynamic array formula
calculate_rangeboolWhether calculate the spilled range for this dynamic array formula.
If the “values” parameter is not null and this flag is false,
then the spilled range’s height will be values.Length and width will be values[0].Length.
calculate_valueboolwhether calculate this dynamic array formula for those cells in the spilled range when “values” is null
or corresponding item in “values” for one cell is null.

Remarks

the returned range may be not same with the actual one that this dynamic array formula spills into. If there are non-empty cells in the range, the formula will be set for current cell only and marked as “#SPILL!”. But for such kind of situation we still return the whole range that this formula should spill into.

set_dynamic_array_formula

Sets dynamic array formula and make the formula spill into neighboring cells if possible.

Returns

the range that the formula should spill into.

def set_dynamic_array_formula(self, array_formula, options, values, calculate_range, calculate_value, copts):
    ...
ParameterTypeDescription
array_formulastrthe formula expression
optionsFormulaParseOptionsoptions to parse formula.
“Parse” option will be ignored and the formula will always be parsed immediately
valueslistvalues(calculated results) for those cells with given dynamic array formula
calculate_rangeboolWhether calculate the spilled range for this dynamic array formula.
If the “values” parameter is not null and this flag is false,
then the spilled range’s height will be values.Length and width will be values[0].Length.
calculate_valueboolwhether calculate this dynamic array formula for those cells in the spilled range when “values” is null
or corresponding item in “values” for one cell is null.
coptsCalculationOptionsThe options for calculating formula.
Commonly, for performance consideration, the CalculationOptions.recursive property should be false.

Remarks

the returned range may be not same with the actual one that this dynamic array formula spills into. If there are non-empty cells in the range, the formula will be set for current cell only and marked as “#SPILL!”. But for such kind of situation we still return the whole range that this formula should spill into.

See Also