Style Class
Represents a workbook (master) style which can be shared by multiple cells.
- Inheritance:
- System.ObjectStyle
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
Properties
Hidden
Gets or sets a value indicating whether this style is hidden in the application UI.
Property Value
- System.Boolean
true if this style is hidden in the application UI; otherwise, false.
IncludeAlignment
Gets or sets a value indicating whether the alignment formatting specified for this style will be used when this style is applied to a cell.
Property Value
- System.Boolean
true if alignment formatting specified for this style will be used when this style is applied to a cell; otherwise, false.
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
IncludeBorder
Gets or sets a value indicating whether the border formatting specified for this style will be used when this style is applied to a cell.
Property Value
- System.Boolean
true if border formatting specified for this style will be used when this style is applied to a cell; otherwise, false.
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
IncludeFill
Gets or sets a value indicating whether the fill formatting specified for this style will be used when this style is applied to a cell.
Property Value
- System.Boolean
true if fill formatting specified for this style will be used when this style is applied to a cell; otherwise, false.
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
IncludeFont
Gets or sets a value indicating whether the font formatting specified for this style will be used when this style is applied to a cell.
Property Value
- System.Boolean
true if font formatting specified for this style will be used when this style is applied to a cell; otherwise, false.
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
IncludeNumber
Gets or sets a value indicating whether the number formatting specified for this style will be used when this style is applied to a cell.
Property Value
- System.Boolean
true if number formatting specified for this style will be used when this style is applied to a cell; otherwise, false.
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
IncludeProtection
Gets or sets a value indicating whether the protection formatting specified for this style will be used when this style is applied to a cell.
Property Value
- System.Boolean
true if protection formatting specified for this style will be used when this style is applied to a cell; otherwise, false.
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
Language
Gets or sets the language for this style.
Property Value
- System.Globalization.CultureInfo
Name
Gets or sets the name of this style.
Property Value
- System.String
The name of this style.
Remarks
Conceptually, cell formatting is divided into following groups:
- Number - indicates how to format and render the numeric value of a cell. Associated property is NumberFormat.
- Alignment - formatting information pertaining to text alignment in cells. Associated properties are HorizontalAlignment, VerticalAlignment, Indent, Rotation, IsTextVertical, WrapText and ShrinkToFit.
- Font - defines the properties for the used font. Associated property is Font.
- Border - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is Borders.
- Fill - specifies fill formatting (pattern or gradient). Associated property is FillPattern.
- Protection - contains protection properties associated with the cell. Associated properties are Locked and FormulaHidden.
Additional CellStyle properties not associated with any formatting group are:
- Name - name of the referenced Style.
- QuotePrefix - true to store numeric value of a cell as text; otherwise, false.
- IsDefault - true if Name Style is default (Normal) and there are no additional modifications of cell formatting; otherwise, false.
ExcelFile contains a set of Styles which can be referenced by multiple cells.
ExcelFile must always contain at least one Style which cannot be removed and is, by default, referenced by all cells. This default style is Normal.
Style can either be built-in or user-defined. Built-in style is accessible from Styles via BuiltInCellStyleName enumeration.
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from Name Style, unless cell formatting group or its associated property is modified.
Cell formatting is available for one or more cells through Style property which is available on ExcelCell and CellRange types. Cell formatting specified on ExcelColumn and ExcelRow types through Style property is simply propagated to cell formatting of its Cells.
note
For performance reasons, cell formatting on CellRange is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side.
Setting cell formatting property on CellRange is propagated to each cell in a range.
To set Style to one or more cells, simply assign it to Style property.
tip
Preferable way to modify formatting property of multiple cells is to get CellRange to which all those cells belong, and use Style property of that range to make the modification.
If modifying multiple formatting properties of a CellRange, without preserving unmodified formatting properties, preferable way is to create new instance of CellStyle, make modifications on it, and assign it to Style property of that range.
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting Cells) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint.
Exceptions
- System.InvalidOperationException
Name cannot be changed if style is built-in.
Inherited Properties
| Borders | Gets or sets the borders. If set to null, borders will be resolved from referenced workbook style. (Inherited from CellStyle) |
| FillPattern | Gets or sets the fill (cell background). If set to null, fill will be resolved from referenced workbook style. Fill can be either pattern or gradient. Gradient fill is currently supported in XLSX and partially in rendering engine (PDF, XPS, and image formats). (Inherited from CellStyle) |
| Font | Gets or sets the font. If set to null, font will be resolved from referenced workbook style. (Inherited from CellStyle) |
| FormulaHidden | Gets or sets a value indicating whether the contents of the cell will not be displayed in the formula bar. Default value is false. (Inherited from CellStyle) |
| HorizontalAlignment | Gets or sets the horizontal alignment. Default value is General. (Inherited from CellStyle) |
| Indent | Gets or sets the number of spaces (of the Normal style font) of indentation for text in a cell. The number of spaces to indent is calculated as following: Number of spaces to indent = Indent * 3. Default value is 0. (Inherited from CellStyle) |
| IsDefault | Gets a value indicating whether the referenced workbook style is default (Normal) and there are no additional modifications of cell formatting. (Inherited from CellStyle) |
| IsTextVertical | Gets or sets a value indicating whether text orientation is vertical. Default value is false. (Inherited from CellStyle) |
| Locked | Gets or sets a value indicating whether the cell is locked. Default value is true. (Inherited from CellStyle) |
| NumberFormat | Gets or sets the number format which indicates how to format and render the numeric value of a cell. Default value is General. If set to null, number format will be resolved from referenced workbook style. (Inherited from CellStyle) |
| NumberFormatLocal | Gets a System.String that represents the format code for the numeric value in the language of the user. (Inherited from CellStyle) |
| QuotePrefix | Gets or sets a value indicating whether the text string in a cell should be prefixed by a single quote mark (e.g., 'text). Use it to store numeric value of a cell as text. Default value is false. (Inherited from CellStyle) |
| Rotation | Gets or sets the text rotation in degrees (1/360th of a full circle). Value must be between -90 and 90 and specifies counterclockwise rotation of the text from the normal position. The first letter of the text is considered the center-point of the arc. Default value is 0. (Inherited from CellStyle) |
| ShrinkToFit | Gets or sets a value indicating whether the displayed text in the cell should be shrunk to fit the cell width. Not applicable when a cell contains multiple lines of text. Default value is false. (Inherited from CellStyle) |
| TextDirection | Gets or sets a value indicating whether the reading order of the cell is left-to-right, right-to-left, or context dependent. (Inherited from CellStyle) |
| VerticalAlignment | Gets or sets the vertical alignment. Default value is Bottom. (Inherited from CellStyle) |
| WrapText | Gets or sets a value indicating whether the text in a cell should be line-wrapped within the cell. Default value is false. (Inherited from CellStyle) |
Inherited Methods
| ToString() | Returns a System.String that represents this CellStyle instance. (Inherited from CellStyle) |