Class FunctionArgument

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

Inheritance
System.Object
FunctionArgument
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: OfficeOpenXml.FormulaParsing.Excel.Functions
Assembly: EPPlus.dll
Syntax
public class FunctionArgument

Constructors

FunctionArgument(Object)

Constructor.

Declaration
public FunctionArgument(object val)
Parameters
Type Name Description
System.Object val

The value of the function argument.

FunctionArgument(Object, DataType)

Constructor.

Declaration
public FunctionArgument(object val, DataType dataType)
Parameters
Type Name Description
System.Object val

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

Declaration
public FormulaRangeAddress Address { get; }
Property Value
Type Description
FormulaRangeAddress

DataType

The data type of the Value.

Declaration
public DataType DataType { get; }
Property Value
Type Description
DataType

IsExcelRange

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

Declaration
public bool IsExcelRange { get; }
Property Value
Type Description
System.Boolean

IsExcelRangeOrSingleCell

If the Value is a range.

Declaration
public bool IsExcelRangeOrSingleCell { get; }
Property Value
Type Description
System.Boolean

IsHiddenCell

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

Declaration
public bool IsHiddenCell { get; }
Property Value
Type Description
System.Boolean

Value

The value of the function argument

Declaration
public object Value { get; }
Property Value
Type Description
System.Object

ValueAsExcelErrorValue

Tries to parse Value as ExcelErrorValue

Declaration
public ExcelErrorValue ValueAsExcelErrorValue { get; }
Property Value
Type Description
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.

Declaration
public IRangeInfo ValueAsRangeInfo { get; }
Property Value
Type Description
IRangeInfo

ValueFirst

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

Declaration
public object ValueFirst { get; }
Property Value
Type Description
System.Object

ValueIsExcelError

Returns true if the Value is an ExcelErrorValue

Declaration
public bool ValueIsExcelError { get; }
Property Value
Type Description
System.Boolean

ValueToList

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

Declaration
public List<object> ValueToList { get; }
Property Value
Type Description
System.Collections.Generic.List<System.Object>