Class FunctionArgument¶

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

Represents a function argument passed to the Execute method of a ExcelFunction class. Execute(IList<FunctionArgument>, ParsingContext)

public class FunctionArgument

Inheritance¶

object ← FunctionArgument

Inherited Members¶

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

Constructors¶

FunctionArgument(object)¶

Constructor.

public FunctionArgument(object val)

Parameters¶

val object

The value of the function argument.

FunctionArgument(object, DataType)¶

Constructor.

public FunctionArgument(object val, DataType dataType)

Parameters¶

val object

The value of the function argument.

dataType DataType

The data type of the val. The data type should match the values .NET data type

Properties¶

Address¶

The address for function parameter

public FormulaRangeAddress Address { get; }

Property Value¶

FormulaRangeAddress

DataType¶

The data type of the Value.

public DataType DataType { get; }

Property Value¶

DataType

IsExcelRange¶

If the Value is a range with more than one cell.

public bool IsExcelRange { get; }

Property Value¶

bool

IsExcelRangeOrSingleCell¶

If the Value is a range.

public bool IsExcelRangeOrSingleCell { get; }

Property Value¶

bool

IsHiddenCell¶

If the compile result has a function that handles hidden cells.

public bool IsHiddenCell { get; }

Property Value¶

bool

IsVariableResult¶

public bool IsVariableResult { get; }

Property Value¶

bool

Value¶

The value of the function argument

public object Value { get; }

Property Value¶

object

ValueAsExcelErrorValue¶

Tries to parse Value as ExcelErrorValue

public ExcelErrorValue ValueAsExcelErrorValue { get; }

Property Value¶

ExcelErrorValue

ValueAsRangeInfo¶

If Value is an instance of IRangeInfo or has Address set to a valid address this property will return a IRangeInfo. If not null will be returned.

public IRangeInfo ValueAsRangeInfo { get; }

Property Value¶

IRangeInfo

ValueAsVariableCompileResult¶

public VariableCompileResult ValueAsVariableCompileResult { get; }

Property Value¶

VariableCompileResult

ValueFirst¶

If the value is a IRangeInfo the value will return the value of the first cell, otherwise the Value will be returned.

public object ValueFirst { get; }

Property Value¶

object

ValueIsExcelError¶

Returns true if the Value is an ExcelErrorValue

public bool ValueIsExcelError { get; }

Property Value¶

bool

ValueToList¶

If the value is a IRangeInfo the value will return the value of the first cell, otherwise the Value will be returned.

public List<object> ValueToList { get; }

Property Value¶

List<object>