SoftArtisans OfficeWriter

The Style Object

ExcelWriter has three style types: CellStyle, GlobalStyle, and NamedStyle. All three types derive from the Style class, and NamedStyle derives from GlobalStyle.

Styles can be both "set" and "applied" to ranges, areas, cells, rows, and columns.

To bind a style to a cell or set of cells, call ApplyStyle or applyStyle. Both are accessible through the following objects: Cell, Area, Range, RowProperties, and ColumnProperties .

When a style is "set", it is cloned and the object on which it is "set" acquires all of that style's properties, including font proprties and number formatting

When a style is applied, only the differences between the new style and style properties previously assigned to the cell (through the ExcelWriter API or in Microsoft Excel) will take effect. For example, if the cell has a background color and the new style applied does not contain a background color, the cell's color will not be affected. Note : Properties that were set on a pre-existing style in a workbook will not be propogated to the object to which the style is "applied".

You cannot create a CellStyle, only manipulate existing ones as part of the objects they apply to. To create a GlobalStyle, use Workbook.CreateStyle(). To create a NamedStyle, use Workbook.CreateNamedStyle(). To get a NamedStyle from an existing document, use Workbook.GetNamedStyle().

Examples:

[csharp]

// Open existing spreadsheet
ExcelApplication xla = new ExcelApplication();
Workbook wb = xla.Open(@"C:\MySpreadsheet.xls");

// Create GlobalStyle
Style global = wb.CreateStyle();

// Create NamedStyle
Style newNamed = wb.CreateNamedStyle("MyStyle");

// Get NamedStyle
Style existingNamed = wb.GetNamedStyle("ExistingStyle");

[vbnet]

' Open existing spreadsheet
Dim xla As New ExcelApplication()
Dim wb As Workbook = xla.Open("C:\MySpreadsheet")

' Create GlobalStyle
Dim global As Style = wb.CreateStyle()

' Create NamedStyle
Dim newNamed As Style = wb.CreateNamedStyle("MyStyle")

' Get NamedStyle
Dim existingNamed As Style = wb.GetNamedStyle("ExistingStyle")

Style Enumerations

Name

Description

Style.ColumnInsertBehavior

A ColumnInsertBehavior value determines how a column insert will behave

Style.HAlign

The HAlign class contains all horizontal alignment options

Style.RowInsertBehavior

A RowInsertBehavior value determines how a row insert will behave

Style.TextDir

The TextDirection class contains all text direction options

Style.VAlign