ReoGrid formats cell display and parsing through data formatters. Supported format types include numbers, dates, percent, currency, text, and custom formatters.

Namespace

using unvell.ReoGrid.DataFormat;

Applying Data Formats

Use SetRangeDataFormat on the worksheet:

var sheet = reoGridControl.CurrentWorksheet;

sheet.SetRangeDataFormat("A1:B2", CellDataFormatFlag.Number,
    new NumberDataFormatter.NumberFormatArgs
    {
        DecimalPlaces = 4,
        NegativeStyle = NumberDataFormatter.NumberNegativeStyle.RedBrackets,
        UseSeparator = true,
    });

With undo support:

reoGridControl.DoAction(new SetRangeDataFormatAction("A1:B2",
    CellDataFormatFlag.Number,
    new NumberDataFormatter.NumberFormatArgs { DecimalPlaces = 2 }));

Quick test:

sheet["B2"] = 12345;
sheet["C2"] = 12345.67890;
sheet["B3"] = -1234;
sheet["C3"] = -1234.56789;

CellDataFormatFlag Enum

Number Format

Number format supports thousands separators, decimal places, and negative number styles.

sheet.SetRangeDataFormat("A1:E7", CellDataFormatFlag.Number,
    new NumberDataFormatter.NumberFormatArgs
    {
        DecimalPlaces = 4,
        UseSeparator = true,
    });

NumberFormatArgs Properties

NumberNegativeStyle Enum (Flags)

This is a flags enum — values can be combined with |:

NegativeStyle = NumberDataFormatter.NumberNegativeStyle.Brackets | NumberDataFormatter.NumberNegativeStyle.Red

Negative Number Example

sheet.SetRangeDataFormat("B2", CellDataFormatFlag.Number,
    new NumberDataFormatter.NumberFormatArgs
    {
        DecimalPlaces = 3,
        NegativeStyle = NumberDataFormatter.NumberNegativeStyle.RedBrackets,
        UseSeparator = true,
    });

sheet["B2"] = -12345.67;

DateTime Format

Specify a culture and format pattern using standard .NET datetime patterns:

sheet.SetRangeDataFormat(RangePosition.EntireRange, CellDataFormatFlag.DateTime,
    new DateTimeDataFormatter.DateTimeFormatArgs
    {
        CultureName = "en-US",
        Format = "yyyy/MM/dd",
    });

DateTimeFormatArgs Properties

Note: DateTimeFormatArgs is a struct, not a class.

Percent Format

Values are displayed as percentages. Uses NumberFormatArgs for configuration:

sheet.SetRangeDataFormat(RangePosition.EntireRange, CellDataFormatFlag.Percent,
    new NumberDataFormatter.NumberFormatArgs
    {
        DecimalPlaces = 2,
    });

A cell value of 0.5 displays as 50.00%.

Currency Format

Currency extends number formatting with a currency symbol placed before or after the value.

sheet.SetRangeDataFormat("B2", CellDataFormatFlag.Currency,
    new CurrencyDataFormatter.CurrencyFormatArgs
    {
        CultureEnglishName = "en-US",
        DecimalPlaces = 2,
        UseSeparator = true,
        PrefixSymbol = "$",
    });

sheet["B2"] = 1234;

CurrencyFormatArgs Properties

CurrencyFormatArgs inherits from NumberFormatArgs and adds currency-specific properties:

Prefix with Space

sheet.SetRangeDataFormat("B2", CellDataFormatFlag.Currency,
    new CurrencyDataFormatter.CurrencyFormatArgs
    {
        CultureEnglishName = "en-US",
        DecimalPlaces = 2,
        UseSeparator = true,
        PrefixSymbol = "$ ",   // Note the trailing space
    });

Postfix Symbol

sheet.SetRangeDataFormat("B2", CellDataFormatFlag.Currency,
    new CurrencyDataFormatter.CurrencyFormatArgs
    {
        CultureEnglishName = "en-US",
        DecimalPlaces = 2,
        UseSeparator = true,
        PostfixSymbol = " USD",
    });

Text Format

Use Text to keep values as literal strings with no formatting:

sheet.SetRangeDataFormat(RangePosition.EntireRange, CellDataFormatFlag.Text, null);

Cell Data Format Properties

Access the format on individual cells:

var cell = sheet.Cells["A1"];

// Get the current format
CellDataFormatFlag format = cell.DataFormat;
object formatArgs = cell.DataFormatArgs;

// Set the format
cell.SetDataFormat(CellDataFormatFlag.Number,
    new NumberDataFormatter.NumberFormatArgs { DecimalPlaces = 3 });

Custom Data Formatter

Implement IDataFormatter to create custom formatters:

public interface IDataFormatter
{
    string FormatCell(Cell cell);
    bool PerformTestFormat();
}

Apply with CellDataFormatFlag.Custom:

sheet.SetRangeDataFormat("A1", CellDataFormatFlag.Custom, myFormatterArgs);

// Or set on a cell directly
cell.CustomDataFormatter = new MyCustomFormatter();

See Custom Data Format for detailed examples.

Related Topics

• Cell — Cell properties and data access
• Custom Data Format — Creating custom formatters
• Cell Editing — Input behavior settings
• Settings — Auto-format settings