Create and use a WorksheetRangeStyle object to pass style items into cells or ranges. Call the SetRangeStyles method on the worksheet to apply the style object. ReoGrid uses an enumeration called PlainStyleFlag to determine which styles should be applied.

Namespace

using unvell.ReoGrid;

Set Styles

There are several ways to set cell or range styles:

• Call worksheet methods
• Use a Cell or Range instance
• Use Actions

Call Worksheet Methods

sheet.SetRangeStyles("B1:E5", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.FillColor,
    BackColor = Color.SkyBlue,
});

SetRangeStyles Overloads

Use Cell or Range Instance

// Cell
var cell = sheet.Cells["B3"];
cell.Style.BackColor = Color.SkyBlue;

// Range
var range = sheet.Ranges["B1:C3"];
range.Style.BackColor = Color.LightYellow;

Use Actions

Set styles using an action to enable undo, redo, and repeat operations.

sheet.DoAction(new SetRangeStyleAction("B1:E5", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.FillColor,
    BackColor = Color.SkyBlue,
}));

Get Styles

Call Worksheet Methods

// Get style from a single cell
WorksheetRangeStyle style = sheet.GetCellStyle("B3");
WorksheetRangeStyle style = sheet.GetCellStyle(new CellPosition("B3"));
WorksheetRangeStyle style = sheet.GetCellStyle(2, 1);

Use Cell or Range Instance

// Cell
var backColor = sheet.Cells["B3"].Style.BackColor;

// Range
var backColor = sheet.Ranges["B1:C3"].Style.BackColor;

WorksheetRangeStyle

The WorksheetRangeStyle class holds the style properties to apply. The Flag property determines which style items are included.

Properties

Methods

Note: Always set the Flag property — it determines which style items will be applied. Style properties without the corresponding flag set are ignored.

PlainStyleFlag

The PlainStyleFlag enum (long, flags) specifies which style items to apply or remove.

Individual Flags

Composite Flags

Alignment Enums

ReoGridHorAlign

ReoGridVerAlign

TextWrapMode

Background Color

Set background color for the range B1:E5:

sheet.SetRangeStyles("B1:E5", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.FillColor,
    BackColor = Color.SkyBlue,
});

Background Pattern Color

Set background pattern color for the entire grid (WinForms only):

sheet.SetRangeStyles(RangePosition.EntireRange,
    new WorksheetRangeStyle
    {
        Flag = PlainStyleFlag.FillPattern | PlainStyleFlag.FillColor,
        BackColor = Color.LightYellow,
        FillPatternColor = Color.SkyBlue,
        FillPatternStyle = System.Drawing.Drawing2D.HatchStyle.DiagonalBrick,
    });

Text Color

sheet.SetRangeStyles("B2:B2", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.TextColor,
    TextColor = Color.Red,
});

Text Alignment

Text alignment can be specified in both horizontal and vertical directions.

Set the cell’s horizontal text alignment to Center:

sheet.SetRangeStyles("A1:C3", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.HorizontalAlign,
    HAlign = ReoGridHorAlign.Center,
});

Text Wrap

Set text wrap mode to WordBreak (the default is NoWrap):

sheet[1, 1] = "How many beers can you drink?";
sheet.SetRangeStyles("B2:B2", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.TextWrap,
    TextWrapMode = TextWrapMode.WordBreak,
});

Text Rotation

Set the RotationAngle property to rotate text inside a cell (−90° to 90°):

var cell = sheet.Cells["A1"];
cell.Data = "Hello World";
cell.Style.RotationAngle = 90;

Font

Change font name and size:

sheet.SetRangeStyles("B2:B2", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.FontSize | PlainStyleFlag.FontName,
    FontName = "Arial",
    FontSize = 20,
});

Change font styles:

// Using SetRangeStyles
sheet.SetRangeStyles("B2", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.FontStyleBold,
    Bold = true,
});

sheet.SetRangeStyles("C2", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.FontStyleItalic,
    Italic = true,
});

// Using cell instances
sheet.Cells["B3"].Style.Underline = true;
sheet.Cells["C3"].Style.Strikethrough = true;

Multiple Styles at Once

Combine multiple PlainStyleFlag values using bitwise OR to set several styles in one call:

sheet.SetRangeStyles("A1:D4", new WorksheetRangeStyle
{
    Flag = PlainStyleFlag.FillColor | PlainStyleFlag.TextColor
         | PlainStyleFlag.FontStyleBold | PlainStyleFlag.HorizontalAlign,
    BackColor = Color.LightYellow,
    TextColor = Color.DarkBlue,
    Bold = true,
    HAlign = ReoGridHorAlign.Center,
});

Remove Style

Always remove styles from a range, even for a single cell.

Use Worksheet Method

Specify PlainStyleFlag to determine which styles should be removed:

sheet.RemoveRangeStyles(new RangePosition(2, 2, 3, 3), PlainStyleFlag.BackAll);

RemoveRangeStyles Overloads

Use Actions

sheet.DoAction(new RemoveRangeStyleAction(new RangePosition(2, 2, 3, 3), PlainStyleFlag.BackAll));

Root Style

The RootStyle property on the worksheet defines the default style for all cells:

sheet.RootStyle.FontName = "Consolas";
sheet.RootStyle.FontSize = 12;

Alternate Row Styles

Apply alternating row colors for improved readability:

sheet.AlternateNormalRowColor = SolidColor.White;
sheet.AlternateAccentRowColor = new SolidColor(240, 240, 250);
sheet.AlternateRowRange = new RangePosition("A1:F100");
sheet.AlternateRowStyleMode = AlternateRowStyleMode.ByVisibleRow;

AlternateRowStyleMode

Events

ReferenceCellStyle

The ReferenceCellStyle class is returned by cell.Style. Setting a property on this object automatically applies the style to the cell with the correct flag.

ReferenceRangeStyle

The ReferenceRangeStyle class is returned by range.Style. Setting a property applies the style to the entire range.

Related Topics

• Border — Border styles
• Data Format — Data formatting
• Built-in Actions — Style-related actions
• Custom Cell — Cell body padding