Class ArrayBehaviourConfig¶

Namespace: OfficeOpenXml.FormulaParsing.Excel.Functions
Assembly: EPPlus.dll

This class should be used to configure how arrays/ranges are treated as parameters to functions that can return a dynamic array.

public class ArrayBehaviourConfig

Inheritance¶

object ← ArrayBehaviourConfig

Inherited Members¶

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties¶

ArrayArgInterval¶

Indicates that every x-th argument can be an array.

public int ArrayArgInterval { get; set; }

Property Value¶

int

IgnoreNumberOfArgsFromStart¶

Use this property in combination with ArrayArgInterval. A typical scenario would be that the first 3 arguments should be ignore and then every 3^rd argument might be in array. In this scenario this property should be set to 3.

public int IgnoreNumberOfArgsFromStart { get; set; }

Property Value¶

int

Methods¶

CanBeArrayArg(int)¶

Returns true if the 0-based argIx occurs in the SetArrayParameterIndexes(int[]) list or if the index matches the configuration of IgnoreNumberOfArgsFromStart and ArrayArgInterval.

public bool CanBeArrayArg(int argIx)

Parameters¶

argIx int

argument index (0-based)

Returns¶

bool

SetArrayParameterIndexes(params int[])¶

This method sets indexes of arguments that can be an array.

public void SetArrayParameterIndexes(params int[] indexes)

Parameters¶

indexes int[]

A list of integers that specifies the 0-based index of arguments that can be an array.