OfficeIMO

API Reference

Class

ColumnStyleByHeaderBuilder

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Builder for applying styles/number formats to a column resolved by header.

Inheritance

  • Object
  • ColumnStyleByHeaderBuilder

Methods

public ColumnStyleByHeaderBuilder AlignCenter() #
Returns: ColumnStyleByHeaderBuilder

Centers text in the column.

public ColumnStyleByHeaderBuilder AlignLeft() #
Returns: ColumnStyleByHeaderBuilder

Aligns text left in the column.

public ColumnStyleByHeaderBuilder AlignRight() #
Returns: ColumnStyleByHeaderBuilder

Aligns text right in the column.

Background 2 overloads
public ColumnStyleByHeaderBuilder Background(Color color) #
Returns: ColumnStyleByHeaderBuilder

Applies a solid background fill to the column. Accepts #RRGGBB or #AARRGGBB.

Parameters

hexColor System.String requiredposition: 0
Background(SixLabors.ImageSharp.Color color) #

Applies a solid background fill to the column using an ImageSharp color.

Parameters

color SixLabors.ImageSharp.Color required
Fill color.
BackgroundByTextMap 2 overloads
public ColumnStyleByHeaderBuilder BackgroundByTextMap(IDictionary<String, Color> map, Boolean caseInsensitive = true) #
Returns: ColumnStyleByHeaderBuilder

Applies background fills to cells based on a text→color mapping. Keys are compared case-insensitively by default.

Parameters

map System.Collections.Generic.IDictionary{System.String,System.String} requiredposition: 0
caseInsensitive System.Boolean = true optionalposition: 1
BackgroundByTextMap(System.Collections.Generic.IDictionary{System.String,SixLabors.ImageSharp.Color} arg1, System.Boolean arg2) #

Overload that accepts SixLabors colors for convenience.

Parameters

arg1 System.Collections.Generic.IDictionary{System.String,SixLabors.ImageSharp.Color} required
arg2 System.Boolean required
public ColumnStyleByHeaderBuilder BackgroundWhenTextEquals(String text, String hexColor, Boolean caseInsensitive = true) #
Returns: ColumnStyleByHeaderBuilder

Applies a background fill to cells in this column when their text equals the specified value. Comparison is case-insensitive by default.

Parameters

text System.String requiredposition: 0
hexColor System.String requiredposition: 1
caseInsensitive System.Boolean = true optionalposition: 2
public ColumnStyleByHeaderBuilder Bold() #
Returns: ColumnStyleByHeaderBuilder

Makes all cells in the column bold.

public ColumnStyleByHeaderBuilder BoldByTextSet(ISet<String> values, Boolean caseInsensitive = true) #
Returns: ColumnStyleByHeaderBuilder

Makes the cell bold when its text is in the provided set.

Parameters

values System.Collections.Generic.ISet{System.String} requiredposition: 0
caseInsensitive System.Boolean = true optionalposition: 1
public ColumnStyleByHeaderBuilder BoldWhenTextEquals(String text, Boolean caseInsensitive = true) #
Returns: ColumnStyleByHeaderBuilder

Makes the cell bold when its text equals the specified value.

Parameters

text System.String requiredposition: 0
caseInsensitive System.Boolean = true optionalposition: 1
public ColumnStyleByHeaderBuilder Currency(Int32 decimals = 2, CultureInfo culture = null) #
Returns: ColumnStyleByHeaderBuilder

Applies a currency format using the specified culture.

Parameters

decimals System.Int32 = 2 optionalposition: 0
Number of decimal places.
culture System.Globalization.CultureInfo = null optionalposition: 1
Culture for currency symbol.
public ColumnStyleByHeaderBuilder Date(String pattern = "yyyy-mm-dd") #
Returns: ColumnStyleByHeaderBuilder

Applies a date format using the provided pattern.

Parameters

pattern System.String = "yyyy-mm-dd" optionalposition: 0
Date format pattern.
public ColumnStyleByHeaderBuilder DateTime(String pattern = "yyyy-mm-dd hh:mm:ss") #
Returns: ColumnStyleByHeaderBuilder

Applies a date and time format using the provided pattern.

Parameters

pattern System.String = "yyyy-mm-dd hh:mm:ss" optionalposition: 0
DateTime format pattern.
public ColumnStyleByHeaderBuilder DurationHours() #
Returns: ColumnStyleByHeaderBuilder

Applies a duration format in hours.

public ColumnStyleByHeaderBuilder FontColor(String hexColor) #
Returns: ColumnStyleByHeaderBuilder

Sets font color using hex (#RRGGBB or #AARRGGBB).

Parameters

hexColor System.String requiredposition: 0
public ColumnStyleByHeaderBuilder FontColorByTextMap(IDictionary<String, String> map, Boolean caseInsensitive = true) #
Returns: ColumnStyleByHeaderBuilder

Sets font colors by matching cell text to a provided mapping of text→hex color.

Parameters

map System.Collections.Generic.IDictionary{System.String,System.String} requiredposition: 0
caseInsensitive System.Boolean = true optionalposition: 1
public ColumnStyleByHeaderBuilder Integer() #
Returns: ColumnStyleByHeaderBuilder

Applies an integer number format.

public ColumnStyleByHeaderBuilder Number(Int32 decimals = 0) #
Returns: ColumnStyleByHeaderBuilder

Applies a numeric format with optional decimal places.

Parameters

decimals System.Int32 = 0 optionalposition: 0
Number of decimal places.
public ColumnStyleByHeaderBuilder NumberFormat(String format) #
Returns: ColumnStyleByHeaderBuilder

Applies a custom number format string.

Parameters

format System.String requiredposition: 0
Number format pattern.
public ColumnStyleByHeaderBuilder Percent(Int32 decimals = 0) #
Returns: ColumnStyleByHeaderBuilder

Applies a percentage format.

Parameters

decimals System.Int32 = 0 optionalposition: 0
Number of decimal places.
public ColumnStyleByHeaderBuilder Text() #
Returns: ColumnStyleByHeaderBuilder

Applies a text format.

public ColumnStyleByHeaderBuilder Time() #
Returns: ColumnStyleByHeaderBuilder

Applies a time format.