Interface IStyle
Interface for cell style
Namespace: IronXL.Styles
Assembly: IronXL.dll
Syntax
public interface IStyle
IStyle is what a cell or range hands back when a developer wants to control how it looks. Reading Cell.Style or Range.Style returns this contract, and everything about a cell's appearance, the fill color, font, borders, alignment, rotation, and text wrapping, is set through it. It is the single styling surface in IronXL, so the same object covers a one-cell tweak and a whole-range format.
A developer obtains IStyle rather than constructing it: Cell.Style and Range.Style both expose it as a get-only property, so styling means reading the property and assigning to its members. Assigning to a range's Style applies the change across every cell in the selection in one pass, which is how column-wide or table-wide formatting is done without looping. A single cell and a wide selection use the same surface, so the styling code does not change as the target grows.
The everyday members fall into a few groups. Font returns an IFont for typeface, size, bold, italic, and color; the four side borders (TopBorder, BottomBorder, LeftBorder, RightBorder) plus DiagonalBorder each return an IBorder for line color and style, with DiagonalBorderDirection setting which way a diagonal runs. Fill is handled by BackgroundColor together with FillPattern, or through the SetBackgroundColor helper that accepts a Color or an RGB string. Layout comes from HorizontalAlignment, VerticalAlignment, WrapText, ShrinkToFit, Indention, and Rotation. Because the border and font members return their own interfaces, a fluent path like range.Style.Font.Bold = true is the normal idiom.
using IronXL;
WorkBook workbook = WorkBook.Load("report.xlsx");
WorkSheet sheet = workbook.DefaultWorkSheet;
IStyle headerStyle = sheet["A1:D1"].Style;
headerStyle.Font.Bold = true;
headerStyle.SetBackgroundColor("#DDEBF7");
headerStyle.BottomBorder.SetBorderStyle("#000000", BorderType.Thin);The style cells, borders, and fonts example demonstrates the full surface, the border and alignment how-to covers borders and layout, and the background pattern color how-to handles fills.
Properties
BackgroundColor
Gets the color of the background in rgb format. E.g. #ffffff
Declaration
string BackgroundColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
BottomBorder
Property that represents cell bottom border
Declaration
IBorder BottomBorder { get; }
Property Value
| Type | Description |
|---|---|
| IBorder |
DiagonalBorder
Property that represents cell diagonal border
Declaration
IBorder DiagonalBorder { get; }
Property Value
| Type | Description |
|---|---|
| IBorder |
DiagonalBorderDirection
Gets or sets the diagonal border direction value.
Declaration
DiagonalBorderDirection DiagonalBorderDirection { get; set; }
Property Value
| Type | Description |
|---|---|
| DiagonalBorderDirection |
FillPattern
Gets or sets fill pattern of the cell.
Declaration
FillPattern FillPattern { get; set; }
Property Value
| Type | Description |
|---|---|
| FillPattern |
Font
Property that represents cell font value
Declaration
IFont Font { get; }
Property Value
| Type | Description |
|---|---|
| IFont |
HorizontalAlignment
Gets or sets the horizontal alignment of the cell.
Declaration
HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
| Type | Description |
|---|---|
| HorizontalAlignment |
Indention
Get the number of spaces to indent the text in the cell
Declaration
short Indention { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int16 |
LeftBorder
Property that represents cell left border
Declaration
IBorder LeftBorder { get; }
Property Value
| Type | Description |
|---|---|
| IBorder |
RightBorder
Property that represents cell right border
Declaration
IBorder RightBorder { get; }
Property Value
| Type | Description |
|---|---|
| IBorder |
Rotation
Get the degree of rotation (between -90 and 90 degrees) for the text in the cell
Declaration
short Rotation { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int16 |
ShrinkToFit
Gets or sets a value indicating whether the cell should be auto-sized to shrink to fit if the text is too long
Declaration
bool ShrinkToFit { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TopBorder
Property that represents cell top border
Declaration
IBorder TopBorder { get; }
Property Value
| Type | Description |
|---|---|
| IBorder |
VerticalAlignment
Gets or sets the vertical alignment of the cell.
Declaration
VerticalAlignment VerticalAlignment { get; set; }
Property Value
| Type | Description |
|---|---|
| VerticalAlignment |
WrapText
Bool property that indicates if text is wrapped
Declaration
bool WrapText { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
SetBackgroundColor(Color)
Method for setting cell background color with IronSoftware.Drawing.Color value
Declaration
void SetBackgroundColor(Color color)
Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.Drawing.Color | color | Color value |
SetBackgroundColor(String)
Method for setting cell background color with an rgb string.
Declaration
void SetBackgroundColor(string rgb)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | rgb | Color RGB value |