Back to Devexpress

IWorkbook.Styles Property

officefileapi-devexpress-dot-spreadsheet-dot-iworkbook-e4d3f3ec.md

latest7.2 KB
Original Source

IWorkbook.Styles Property

Provides access to the collection of cell styles in the current workbook.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
StyleCollection Styles { get; }
vb
ReadOnly Property Styles As StyleCollection

Property Value

TypeDescription
StyleCollection

A StyleCollection collection containing cell styles.

|

Remarks

By default, StyleCollection contains Microsoft® Excel® built-in styles, including the Normal style that is applied to cells by default (StyleCollection.DefaultStyle). You can create custom styles, as well as copy, modify or delete existing styles (see the How to: Create or Modify a Style example).

Example

This example demonstrates how to format a cell, a range of cells, an entire row or an entire column by applying a style.

  1. Access the Style object that specifies the style to be applied to a cell or a range of cells. This style should be added to the IWorkbook.Styles collection.
  2. Assign the required style object to the CellRange.Style property of the cell, cell range, row or column object.

View Example

csharp
// Access the built-in "Good" MS Excel style from the Styles collection of the workbook.
Style styleGood = workbook.Styles[BuiltInStyleId.Good];

// Apply the "Good" style to a range of cells.
worksheet.Range["A1:C4"].Style = styleGood;

// Access a custom style that has been previously created in the loaded document by its name.
Style customStyle = workbook.Styles["Custom Style"];

// Apply the custom style to the cell.
worksheet.Cells["D6"].Style = customStyle;

// Apply the "Good" style to the eighth row.
worksheet.Rows[7].Style = styleGood;

// Apply the custom style to the "H" column.
worksheet.Columns["H"].Style = customStyle;
vb
' Access the built-in "Good" MS Excel style from the Styles collection of the workbook.
Dim styleGood As Style = workbook.Styles(BuiltInStyleId.Good)

' Apply the "Good" style to a range of cells.
worksheet.Range("A1:C4").Style = styleGood

' Access a custom style that has been previously created in the loaded document by its name.
Dim customStyle As Style = workbook.Styles("Custom Style")

' Apply the custom style to the cell.
worksheet.Cells("D6").Style = customStyle

' Apply the "Good" style to the eighth row.
worksheet.Rows(7).Style = styleGood

' Apply the custom style to the "H" column.
worksheet.Columns("H").Style = customStyle

The following code snippets (auto-collected from DevExpress Examples) contain references to the Styles property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/DocumentPropertiesActions.cs#L26

csharp
header[1].Value = "Value";
header.Style = workbook.Styles[BuiltInStyleId.Accent2];

wpf-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/DocumentPropertiesActions.cs#L26

csharp
header[1].Value = "Value";
header.Style = workbook.Styles[BuiltInStyleId.Accent2];

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/DocumentPropertiesActions.cs#L25

csharp
header[1].Value = "Value";
header.Style = workbook.Styles[BuiltInStyleId.Accent2];

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/DocumentPropertiesActions.vb#L22

vb
header(1).Value = "Value"
header.Style = workbook.Styles(BuiltInStyleId.Accent2)

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/DocumentPropertiesActions.vb#L22

vb
header(1).Value = "Value"
header.Style = workbook.Styles(BuiltInStyleId.Accent2)

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/DocumentPropertiesActions.vb#L25

vb
header(1).Value = "Value"
                header.Style = workbook.Styles(BuiltInStyleId.Accent2)
#Region "#Built-inProperties"

See Also

How to: Apply a Style to a Cell or Range of Cells

How to: Create or Modify a Cell Style

IWorkbook Interface

IWorkbook Members

DevExpress.Spreadsheet Namespace