Back to Devexpress

IXlFormulaParameter Interface

corelibraries-devexpress-dot-export-dot-xl-2821da92.md

latest9.6 KB
Original Source

IXlFormulaParameter Interface

An internal representation of an expression. Used to set the cell formula.

Namespace : DevExpress.Export.Xl

Assembly : DevExpress.Printing.v25.2.Core.dll

NuGet Package : DevExpress.Printing.Core

Declaration

csharp
public interface IXlFormulaParameter
vb
Public Interface IXlFormulaParameter

The following members return IXlFormulaParameter objects:

Show 34 links

Remarks

The IXlFormulaParameter objects are created from values using the XlFunc.Param method. Subsequently, you can use the XlOper and XlFunc class methods to construct an expression that is also the IXlFormulaParameter object.

To obtain a textual expression, call the IXlFormulaParameter.ToString method.

Example

This code snippet creates an IXlFormulaParameter expression from a combination of constants, operators and functions. Constants are transformed into the IXlFormulaParameter objects with the XlFunc.Param method. Operators are static methods of the XlOper object and functions are static methods of the XlFunc object.

When an expression is created, the IXlCell.SetFormula method is used to enter expression into a worksheet cell as the cell formula.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/excel-export-api-examples

csharp
// Create the total row using IXlFormulaParameter.
using (IXlRow row = sheet.CreateRow()) {
    row.SkipCells(2);
    using (IXlCell cell = row.CreateCell()) {
        cell.Value = "Total:";
        cell.ApplyFormatting(totalRowFormatting);
    }
    using (IXlCell cell = row.CreateCell()) {
        // Set the formula to calculate the total amount plus 10 handling fee.
        // =SUM($D$2:$D$5)+10
        IXlFormulaParameter const10 = XlFunc.Param(10);
        IXlFormulaParameter sumAmountFunction = XlFunc.Sum(XlCellRange.FromLTRB(cell.ColumnIndex, 1, cell.ColumnIndex, row.RowIndex - 1).AsAbsolute());
        cell.SetFormula(XlOper.Add(sumAmountFunction, const10));
        cell.ApplyFormatting(totalRowFormatting);
    }
}
vb
' Create the total row using IXlFormulaParameter.
Using row As IXlRow = sheet.CreateRow()
    row.SkipCells(2)
    Using cell As IXlCell = row.CreateCell()
        cell.Value = "Total:"
        cell.ApplyFormatting(totalRowFormatting)
    End Using
    Using cell As IXlCell = row.CreateCell()
        ' Set the formula to calculate the total amount plus 10 handling fee.
        ' =SUM($D$2:$D$5)+10
        Dim const10 As IXlFormulaParameter = XlFunc.Param(10)
        Dim sumAmountFunction As IXlFormulaParameter = XlFunc.Sum(XlCellRange.FromLTRB(cell.ColumnIndex, 1, cell.ColumnIndex, row.RowIndex - 1).AsAbsolute())
        cell.SetFormula(XlOper.Add(sumAmountFunction, const10))
        cell.ApplyFormatting(totalRowFormatting)
    End Using
End Using

See Also

IXlFormulaParameter Members

XlOper

XlFunc

SetFormula

DevExpress.Export.Xl Namespace