Class ArrayBehaviourConfig

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

Inheritance

object

ArrayBehaviourConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OfficeOpenXml.FormulaParsing.Excel.Functions

Assembly: EPPlus.dll

Syntax

public class ArrayBehaviourConfig

Properties

ArrayArgInterval

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

Declaration

public int ArrayArgInterval { get; set; }

Property Value

Type	Description
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 3rd argument might be in array. In this scenario this property should be set to 3.

Declaration

public int IgnoreNumberOfArgsFromStart { get; set; }

Property Value

Type	Description
int

Methods

CanBeArrayArg(int)

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

Declaration

public bool CanBeArrayArg(int argIx)

Parameters

Type	Name	Description
int	argIx	argument index (0-based)

Returns

Type	Description
bool

SetArrayParameterIndexes(params int[])

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

Declaration

public void SetArrayParameterIndexes(params int[] indexes)

Parameters

Type	Name	Description
int[]	indexes	A list of integers that specifies the 0-based index of arguments that can be an array.