Class for handling of basic Excel formulas. More...

Static Public Member Functions
static Cell	Average (Range range)
	Returns a cell with an average formula.
static Cell	Average (Worksheet target, Range range)
	Returns a cell with an average formula.
static Cell	Ceil (Address address, int decimals)
	Returns a cell with a ceil formula.
static Cell	Ceil (Worksheet target, Address address, int decimals)
	Returns a cell with a ceil formula.
static Cell	Floor (Address address, int decimals)
	Returns a cell with a floor formula.
static Cell	Floor (Worksheet target, Address address, int decimals)
	Returns a cell with a floor formula.
static Cell	Max (Range range)
	Returns a cell with a max formula.
static Cell	Max (Worksheet target, Range range)
	Returns a cell with a max formula.
static Cell	Median (Range range)
	Returns a cell with a median formula.
static Cell	Median (Worksheet target, Range range)
	Returns a cell with a median formula.
static Cell	Min (Range range)
	Returns a cell with a min formula.
static Cell	Min (Worksheet target, Range range)
	Returns a cell with a min formula.
static Cell	Round (Address address, int decimals)
	Returns a cell with a round formula.
static Cell	Round (Worksheet target, Address address, int decimals)
	Returns a cell with a round formula.
static Cell	Sum (Range range)
	Returns a cell with a sum formula.
static Cell	Sum (Worksheet target, Range range)
	Returns a cell with a sum formula.
static Cell	VLookup (object number, Range range, int columnIndex, bool exactMatch)
	Function to generate a Vlookup as Excel function.
static Cell	VLookup (object number, Worksheet rangeTarget, Range range, int columnIndex, bool exactMatch)
	Function to generate a Vlookup as Excel function.
static Cell	VLookup (Address address, Range range, int columnIndex, bool exactMatch)
	Function to generate a Vlookup as Excel function.
static Cell	VLookup (Worksheet queryTarget, Address address, Worksheet rangeTarget, Range range, int columnIndex, bool exactMatch)
	Function to generate a Vlookup as Excel function.

Detailed Description

Class for handling of basic Excel formulas.

Definition at line 18 of file BasicFormulas.cs.

Member Function Documentation

◆ Average() [1/2]

Cell NanoXLSX.BasicFormulas.Average ( Range range )

static

Returns a cell with an average formula.

Parameters

range Cell range to apply the average operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 25 of file BasicFormulas.cs.

◆ Average() [2/2]

Cell NanoXLSX.BasicFormulas.Average	(	Worksheet	target,
		Range	range )

static

Returns a cell with an average formula.

Parameters

target	Target worksheet of the average operation. Can be null if on the same worksheet
range	Cell range to apply the average operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 34 of file BasicFormulas.cs.

◆ Ceil() [1/2]

Cell NanoXLSX.BasicFormulas.Ceil	(	Address	address,
		int	decimals )

static

Returns a cell with a ceil formula.

Parameters

address	Address to apply the ceil operation to
decimals	Number of decimals (digits)

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 43 of file BasicFormulas.cs.

◆ Ceil() [2/2]

Cell NanoXLSX.BasicFormulas.Ceil	(	Worksheet	target,
		Address	address,
		int	decimals )

static

Returns a cell with a ceil formula.

Parameters

target	Target worksheet of the ceil operation. Can be null if on the same worksheet
address	Address to apply the ceil operation to
decimals	Number of decimals (digits)

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 53 of file BasicFormulas.cs.

◆ Floor() [1/2]

Cell NanoXLSX.BasicFormulas.Floor	(	Address	address,
		int	decimals )

static

Returns a cell with a floor formula.

Parameters

address	Address to apply the floor operation to
decimals	Number of decimals (digits)

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 62 of file BasicFormulas.cs.

◆ Floor() [2/2]

Cell NanoXLSX.BasicFormulas.Floor	(	Worksheet	target,
		Address	address,
		int	decimals )

static

Returns a cell with a floor formula.

Parameters

target	Target worksheet of the floor operation. Can be null if on the same worksheet
address	Address to apply the floor operation to
decimals	Number of decimals (digits)

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 72 of file BasicFormulas.cs.

◆ Max() [1/2]

Cell NanoXLSX.BasicFormulas.Max ( Range range )

static

Returns a cell with a max formula.

Parameters

range Cell range to apply the max operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 80 of file BasicFormulas.cs.

◆ Max() [2/2]

Cell NanoXLSX.BasicFormulas.Max	(	Worksheet	target,
		Range	range )

static

Returns a cell with a max formula.

Parameters

target	Target worksheet of the max operation. Can be null if on the same worksheet
range	Cell range to apply the max operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 89 of file BasicFormulas.cs.

◆ Median() [1/2]

Cell NanoXLSX.BasicFormulas.Median ( Range range )

static

Returns a cell with a median formula.

Parameters

range Cell range to apply the median operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 97 of file BasicFormulas.cs.

◆ Median() [2/2]

Cell NanoXLSX.BasicFormulas.Median	(	Worksheet	target,
		Range	range )

static

Returns a cell with a median formula.

Parameters

target	Target worksheet of the median operation. Can be null if on the same worksheet
range	Cell range to apply the median operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 106 of file BasicFormulas.cs.

◆ Min() [1/2]

Cell NanoXLSX.BasicFormulas.Min ( Range range )

static

Returns a cell with a min formula.

Parameters

range Cell range to apply the min operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 114 of file BasicFormulas.cs.

◆ Min() [2/2]

Cell NanoXLSX.BasicFormulas.Min	(	Worksheet	target,
		Range	range )

static

Returns a cell with a min formula.

Parameters

target	Target worksheet of the min operation. Can be null if on the same worksheet
range	Cell range to apply the median operation to

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 123 of file BasicFormulas.cs.

◆ Round() [1/2]

Cell NanoXLSX.BasicFormulas.Round	(	Address	address,
		int	decimals )

static

Returns a cell with a round formula.

Parameters

address	Address to apply the round operation to
decimals	Number of decimals (digits)

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 132 of file BasicFormulas.cs.

◆ Round() [2/2]

Cell NanoXLSX.BasicFormulas.Round	(	Worksheet	target,
		Address	address,
		int	decimals )

static

Returns a cell with a round formula.

Parameters

target	Target worksheet of the round operation. Can be null if on the same worksheet
address	Address to apply the round operation to
decimals	Number of decimals (digits)

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 142 of file BasicFormulas.cs.

◆ Sum() [1/2]

Cell NanoXLSX.BasicFormulas.Sum ( Range range )

static

Returns a cell with a sum formula.

Parameters

range Cell range to get a sum of

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 150 of file BasicFormulas.cs.

◆ Sum() [2/2]

Cell NanoXLSX.BasicFormulas.Sum	(	Worksheet	target,
		Range	range )

static

Returns a cell with a sum formula.

Parameters

target	Target worksheet of the sum operation. Can be null if on the same worksheet
range	Cell range to get a sum of

Returns: Prepared Cell object, ready to be added to a worksheet

Definition at line 159 of file BasicFormulas.cs.

◆ VLookup() [1/4]

Cell NanoXLSX.BasicFormulas.VLookup	(	Address	address,
		Range	range,
		int	columnIndex,
		bool	exactMatch )

static

Function to generate a Vlookup as Excel function.

Parameters

address	Query address of a cell as string as source of the lookup
range	Matrix of the lookup
columnIndex	Column index of the target column within the range (1 based)
exactMatch	If true, an exact match is applied to the lookup

Returns: Prepared Cell object, ready to be added to a worksheet

Exceptions

FormatException A format exception is thrown if the column index is invalid

Definition at line 197 of file BasicFormulas.cs.

◆ VLookup() [2/4]

Cell NanoXLSX.BasicFormulas.VLookup	(	object	number,
		Range	range,
		int	columnIndex,
		bool	exactMatch )

static

Function to generate a Vlookup as Excel function.

Parameters

number	Numeric value for the lookup. Valid types are int, uint, long, ulong, float, double, byte, sbyte, decimal, short and ushort
range	Matrix of the lookup
columnIndex	Column index of the target column within the range (1 based)
exactMatch	If true, an exact match is applied to the lookup

Returns: Prepared Cell object, ready to be added to a worksheet

Exceptions

FormatException A format exception is thrown if the value or column index is invalid

Definition at line 172 of file BasicFormulas.cs.

◆ VLookup() [3/4]

Cell NanoXLSX.BasicFormulas.VLookup	(	object	number,
		Worksheet	rangeTarget,
		Range	range,
		int	columnIndex,
		bool	exactMatch )

static

Function to generate a Vlookup as Excel function.

Parameters

number	Numeric value for the lookup. Valid types are int, uint, long, ulong, float, double, byte, sbyte, decimal, short and ushort
rangeTarget	Target worksheet of the matrix. Can be null if on the same worksheet
range	Matrix of the lookup
columnIndex	Column index of the target column within the range (1 based)
exactMatch	If true, an exact match is applied to the lookup

Returns: Prepared Cell object, ready to be added to a worksheet

Exceptions

FormatException A format exception is thrown if the value or column index is invalid

Definition at line 185 of file BasicFormulas.cs.

◆ VLookup() [4/4]

Cell NanoXLSX.BasicFormulas.VLookup	(	Worksheet	queryTarget,
		Address	address,
		Worksheet	rangeTarget,
		Range	range,
		int	columnIndex,
		bool	exactMatch )

static

Function to generate a Vlookup as Excel function.

Parameters

queryTarget	Target worksheet of the query argument. Can be null if on the same worksheet
address	Query address of a cell as string as source of the lookup
rangeTarget	Target worksheet of the matrix. Can be null if on the same worksheet
range	Matrix of the lookup
columnIndex	Column index of the target column within the range (1 based)
exactMatch	If true, an exact match is applied to the lookup

Returns: Prepared Cell object, ready to be added to a worksheet

Exceptions

FormatException A format exception is thrown if the column index is invalid

Definition at line 211 of file BasicFormulas.cs.

The documentation for this class was generated from the following file:

BasicFormulas.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Average() [1/2]

◆ Average() [2/2]

◆ Ceil() [1/2]

◆ Ceil() [2/2]

◆ Floor() [1/2]

◆ Floor() [2/2]

◆ Max() [1/2]

◆ Max() [2/2]

◆ Median() [1/2]

◆ Median() [2/2]

◆ Min() [1/2]

◆ Min() [2/2]

◆ Round() [1/2]

◆ Round() [2/2]

◆ Sum() [1/2]

◆ Sum() [2/2]

◆ VLookup() [1/4]

◆ VLookup() [2/4]

◆ VLookup() [3/4]

◆ VLookup() [4/4]