New to Telerik Document Processing? Start a free 30-day trial

Index

Class

Implements the INDEX function, which returns the cell reference or value at the intersection of a specified row and column within a range or array.

Definition

Constructors

Initializes a new INDEX function instance.

C#
public Index()

Fields

The name of the function.

C#
public static readonly string FunctionName

Properties

Gets the rules that define how arguments are converted during function evaluation.

C#
public override ArgumentConversionRules ArgumentConversionRules { get; }
Property Value:

The argument conversion rules as ArgumentConversionRules.

Overrides: FunctionBase.ArgumentConversionRules

Gets the metadata describing the INDEX function's category, description, and argument requirements.

C#
public override FunctionInfo FunctionInfo { get; }
Property Value:

The function info as FunctionInfo.

Overrides: FunctionBase.FunctionInfo

When true, FunctionBase automatically evaluates this function element-wise over any multi-element array argument and returns a spilled array result. Override to true in pure scalar functions (e.g. ABS, LEN, MOD) where applying the function independently to each element of an input array is the correct dynamic-array behavior. Leave false (the default) for reducers.

C#
public override bool LiftsOverArrays { get; }

Overrides: FunctionBase.LiftsOverArrays

Gets the name of the function as "INDEX".

C#
public override string Name { get; }
Property Value:

The name as String.

Overrides: FunctionBase.Name

Methods

Evaluates the INDEX function by locating and returning the cell reference or value at the specified row and column coordinates.

C#
protected override RadExpression EvaluateOverride(FunctionEvaluationContext<object> context)
Parameters:contextFunctionEvaluationContext<object>

The context.

Returns:

RadExpression

Functions result as RadExpression.

Overrides: FunctionWithArguments.EvaluateOverride(FunctionEvaluationContext<object>)

Determines whether the argument at argumentIndex can cause this function to return a multi-element array (and therefore to spill). The default implementation combines the argument metadata with the argument expression's array-return capability. Override when spilling depends on the argument's runtime value.

C#
public override bool IsSpillingArgument(int argumentIndex, RadExpression argument)
Parameters:argumentIndexintargumentRadExpressionReturns:

bool

Overrides: FunctionBase.IsSpillingArgument(int, RadExpression)