GemBox.Spreadsheet

CellStyle Class

Contains settings specifying how the cell data will be displayed.

For a list of all members of this type, see CellStyle Members.

System.Object
   GemBox.Spreadsheet.CellStyle

public sealed class CellStyle

Thread Safety

Public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

Remarks

Various settings control various display aspects: alignment, patterns and shading, indentation, rotation, cell protection, text wrapping, number format, font related settings and cell borders. You can set cell style of a specific Excel through its Style property, or you can create new cell style with desired properties and apply it to unlimited number of Excel objects. Note, however, that number of distinct cell styles in Excel file can't exceed ExcelFile.MaxCellStyles. You don't have to worry about creating duplicate cell styles; internal caching engine will eliminate duplicates in appropriate moments.

Example

Following code demonstrates various cell style properties:

[Visual Basic]
    Sub StylesSample(ByVal ws As ExcelWorksheet)
        ws.Cells(0, 0).Value = "Cell style examples:"

        Dim row As Integer = 0

        ' Column width of 4, 30 and 35 characters.
        ws.Columns(0).Width = 4 * 256
        ws.Columns(1).Width = 30 * 256
        ws.Columns(2).Width = 35 * 256

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Borders.SetBorders(...)"
        ws.Cells(row, 2).Style.Borders.SetBorders(MultipleBorders.All, Color.FromArgb(252, 1, 1), LineStyle.Thin)

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.FillPattern.SetPattern(...)"
        ws.Cells(row, 2).Style.FillPattern.SetPattern(FillPatternStyle.ThinHorizontalCrosshatch, Color.Green, Color.Yellow)

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.Color ="
        ws.Cells(row, 2).Value = "Color.Blue"
        ws.Cells(row, 2).Style.Font.Color = Color.Blue

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.Italic ="
        ws.Cells(row, 2).Value = "true"
        ws.Cells(row, 2).Style.Font.Italic = True

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.Name ="
        ws.Cells(row, 2).Value = "Comic Sans MS"
        ws.Cells(row, 2).Style.Font.Name = "Comic Sans MS"

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.ScriptPosition ="
        ws.Cells(row, 2).Value = "ScriptPosition.Superscript"
        ws.Cells(row, 2).Style.Font.ScriptPosition = ScriptPosition.Superscript

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.Size ="
        ws.Cells(row, 2).Value = "18 * 20"
        ws.Cells(row, 2).Style.Font.Size = 18 * 20

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.Strikeout ="
        ws.Cells(row, 2).Value = "true"
        ws.Cells(row, 2).Style.Font.Strikeout = True

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.UnderlineStyle ="
        ws.Cells(row, 2).Value = "UnderlineStyle.Double"
        ws.Cells(row, 2).Style.Font.UnderlineStyle = UnderlineStyle.Double

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Font.Weight ="
        ws.Cells(row, 2).Value = "ExcelFont.BoldWeight"
        ws.Cells(row, 2).Style.Font.Weight = ExcelFont.BoldWeight

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.HorizontalAlignment ="
        ws.Cells(row, 2).Value = "HorizontalAlignmentStyle.Center"
        ws.Cells(row, 2).Style.HorizontalAlignment = HorizontalAlignmentStyle.Center

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Indent"
        ws.Cells(row, 2).Value = "five"
        ws.Cells(row, 2).Style.HorizontalAlignment = HorizontalAlignmentStyle.Left
        ws.Cells(row, 2).Style.Indent = 5

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.IsTextVertical = "
        ws.Cells(row, 2).Value = "true"
        ' Set row height to 50 points.
        ws.Rows(row).Height = 50 * 20
        ws.Cells(row, 2).Style.IsTextVertical = True

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.NumberFormat"
        ws.Cells(row, 2).Value = 1234
        ws.Cells(row, 2).Style.NumberFormat = "#.##0,00 [$Krakozhian Money Units]"

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.Rotation"
        ws.Cells(row, 2).Value = "35 degrees up"
        ws.Cells(row, 2).Style.Rotation = 35

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.ShrinkToFit"
        ws.Cells(row, 2).Value = "This property is set to true so this text appears shrunk."
        ws.Cells(row, 2).Style.ShrinkToFit = True

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.VerticalAlignment ="
        ws.Cells(row, 2).Value = "VerticalAlignmentStyle.Top"
        ' Set row height to 30 points.
        ws.Rows(row).Height = 30 * 20
        ws.Cells(row, 2).Style.VerticalAlignment = VerticalAlignmentStyle.Top

        row = row + 2
        ws.Cells(row, 1).Value = ".Style.WrapText"
        ws.Cells(row, 2).Value = "This property is set to true so this text appears broken into multiple lines."
        ws.Cells(row, 2).Style.WrapText = True
    End Sub
[C#]
    static void StylesSample(ExcelWorksheet ws)
    {
        ws.Cells[0,0].Value = "Cell style examples:";

        int row = 0;

        // Column width of 4, 30 and 35 characters.
        ws.Columns[0].Width = 4 * 256;
        ws.Columns[1].Width = 30 * 256;
        ws.Columns[2].Width = 35 * 256;

        ws.Cells[row+=2,1].Value = ".Style.Borders.SetBorders(...)";
        ws.Cells[row,2].Style.Borders.SetBorders(MultipleBorders.All, Color.FromArgb(252, 1, 1), LineStyle.Thin);

        ws.Cells[row+=2,1].Value = ".Style.FillPattern.SetPattern(...)";
        ws.Cells[row,2].Style.FillPattern.SetPattern(FillPatternStyle.ThinHorizontalCrosshatch, Color.Green, Color.Yellow);

        ws.Cells[row+=2,1].Value = ".Style.Font.Color =";
        ws.Cells[row,2].Value = "Color.Blue";
        ws.Cells[row,2].Style.Font.Color = Color.Blue;

        ws.Cells[row+=2,1].Value = ".Style.Font.Italic =";
        ws.Cells[row,2].Value = "true";
        ws.Cells[row,2].Style.Font.Italic = true;

        ws.Cells[row+=2,1].Value = ".Style.Font.Name =";
        ws.Cells[row,2].Value = "Comic Sans MS";
        ws.Cells[row,2].Style.Font.Name = "Comic Sans MS";

        ws.Cells[row+=2,1].Value = ".Style.Font.ScriptPosition =";
        ws.Cells[row,2].Value = "ScriptPosition.Superscript";
        ws.Cells[row,2].Style.Font.ScriptPosition = ScriptPosition.Superscript;

        ws.Cells[row+=2,1].Value = ".Style.Font.Size =";
        ws.Cells[row,2].Value = "18 * 20";
        ws.Cells[row,2].Style.Font.Size = 18 * 20;

        ws.Cells[row+=2,1].Value = ".Style.Font.Strikeout =";
        ws.Cells[row,2].Value = "true";
        ws.Cells[row,2].Style.Font.Strikeout = true;

        ws.Cells[row+=2,1].Value = ".Style.Font.UnderlineStyle =";
        ws.Cells[row,2].Value = "UnderlineStyle.Double";
        ws.Cells[row,2].Style.Font.UnderlineStyle = UnderlineStyle.Double;

        ws.Cells[row+=2,1].Value = ".Style.Font.Weight =";
        ws.Cells[row,2].Value = "ExcelFont.BoldWeight";
        ws.Cells[row,2].Style.Font.Weight = ExcelFont.BoldWeight;

        ws.Cells[row+=2,1].Value = ".Style.HorizontalAlignment =";
        ws.Cells[row,2].Value = "HorizontalAlignmentStyle.Center";
        ws.Cells[row,2].Style.HorizontalAlignment = HorizontalAlignmentStyle.Center;

        ws.Cells[row+=2,1].Value = ".Style.Indent";
        ws.Cells[row,2].Value = "five";
        ws.Cells[row,2].Style.HorizontalAlignment = HorizontalAlignmentStyle.Left;
        ws.Cells[row,2].Style.Indent = 5;

        ws.Cells[row+=2,1].Value = ".Style.IsTextVertical = ";
        ws.Cells[row,2].Value = "true";
        // Set row height to 50 points.
        ws.Rows[row].Height = 50 * 20;
        ws.Cells[row,2].Style.IsTextVertical = true;

        ws.Cells[row+=2,1].Value = ".Style.NumberFormat";
        ws.Cells[row,2].Value = 1234;
        ws.Cells[row,2].Style.NumberFormat = "#.##0,00 [$Krakozhian Money Units]";

        ws.Cells[row+=2,1].Value = ".Style.Rotation";
        ws.Cells[row,2].Value = "35 degrees up";
        ws.Cells[row,2].Style.Rotation = 35;

        ws.Cells[row+=2,1].Value = ".Style.ShrinkToFit";
        ws.Cells[row,2].Value = "This property is set to true so this text appears shrunk.";
        ws.Cells[row,2].Style.ShrinkToFit = true;

        ws.Cells[row+=2,1].Value = ".Style.VerticalAlignment =";
        ws.Cells[row,2].Value = "VerticalAlignmentStyle.Top";
        // Set row height to 30 points.
        ws.Rows[row].Height = 30 * 20;
        ws.Cells[row,2].Style.VerticalAlignment = VerticalAlignmentStyle.Top;

        ws.Cells[row+=2,1].Value = ".Style.WrapText";
        ws.Cells[row,2].Value = "This property is set to true so this text appears broken into multiple lines.";
        ws.Cells[row,2].Style.WrapText = true;
    }

Requirements

Namespace: GemBox.Spreadsheet

Assembly: GemBox.Spreadsheet (in GemBox.Spreadsheet.dll)

See Also

CellStyle Members | GemBox.Spreadsheet Namespace