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

Choose

Class

Implements the CHOOSE function, which uses an index number to select and return one value from a list of value arguments.

Definition

Namespace:Telerik.Documents.Spreadsheet.Expressions.Functions.LookupAndReference

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class Choose : FunctionWithArguments

Inheritance: objectFunctionBaseFunctionWithArgumentsChoose

Inherited Members FunctionWithArguments.EvaluateOverride(FunctionEvaluationContext<RadExpression>)FunctionWithArguments.EvaluateLiftedElement(FunctionEvaluationContext<RadExpression>, RadExpression[], int, int)FunctionBase.IsSpillingArgument(int, RadExpression)FunctionBase.Evaluate(FunctionEvaluationContext<RadExpression>)FunctionBase.IsArgumentNumberValid(int)FunctionBase.ArgumentConversionRules...

Constructors

Choose()

Initializes a new CHOOSE function instance.

public Choose()

Fields

FunctionName

string

The name of the function.

public static readonly string FunctionName

Properties

FunctionInfo

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

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.

public override bool LiftsOverArrays { get; }

Overrides: FunctionBase.LiftsOverArrays

Name

string

Gets the name of the function as "CHOOSE".

public override string Name { get; }

Property Value:

The name as String.

Overrides: FunctionBase.Name

Methods

EvaluateOverride(FunctionEvaluationContext<object>)

Evaluates the CHOOSE function by using the index argument to select and return the corresponding value from the list.

protected override RadExpression EvaluateOverride(FunctionEvaluationContext<object> context)

Parameters:contextFunctionEvaluationContext<object>Returns:

RadExpression

Functions result as RadExpression.

Overrides: FunctionWithArguments.EvaluateOverride(FunctionEvaluationContext<object>)