API Reference

Class

ExcelColumnStyleByHeaderBuilder

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

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

Inheritance

  • Object
  • ExcelColumnStyleByHeaderBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

public ExcelColumnStyleByHeaderBuilder AlignCenter() #
Returns: ExcelColumnStyleByHeaderBuilder

Centers text in the column.

public ExcelColumnStyleByHeaderBuilder AlignLeft() #
Returns: ExcelColumnStyleByHeaderBuilder

Aligns text left in the column.

public ExcelColumnStyleByHeaderBuilder AlignRight() #
Returns: ExcelColumnStyleByHeaderBuilder

Aligns text right in the column.

Background 2 overloads
public ExcelColumnStyleByHeaderBuilder Background(String hexColor) #
Returns: ExcelColumnStyleByHeaderBuilder

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

Parameters

hexColor System.String requiredposition: 0
public ExcelColumnStyleByHeaderBuilder Background(OfficeColor color) #
Returns: ExcelColumnStyleByHeaderBuilder

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

Parameters

color OfficeIMO.Drawing.OfficeColor requiredposition: 0
Fill color.
BackgroundByTextMap 2 overloads
public ExcelColumnStyleByHeaderBuilder BackgroundByTextMap(IDictionary<String, String> map, Boolean caseInsensitive = true) #
Returns: ExcelColumnStyleByHeaderBuilder

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
public ExcelColumnStyleByHeaderBuilder BackgroundByTextMap(IDictionary<String, OfficeColor> map, Boolean caseInsensitive = true) #
Returns: ExcelColumnStyleByHeaderBuilder

Overload that accepts OfficeIMO colors for convenience.

Parameters

arg1 System.Collections.Generic.IDictionary{System.String,OfficeIMO.Drawing.OfficeColor} requiredposition: 0
arg2 System.Boolean = true optionalposition: 1
public ExcelColumnStyleByHeaderBuilder BackgroundWhenTextEquals(String text, String hexColor, Boolean caseInsensitive = true) #
Returns: ExcelColumnStyleByHeaderBuilder

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 ExcelColumnStyleByHeaderBuilder Bold() #
Returns: ExcelColumnStyleByHeaderBuilder

Makes all cells in the column bold.

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

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 ExcelColumnStyleByHeaderBuilder BoldWhenTextEquals(String text, Boolean caseInsensitive = true) #
Returns: ExcelColumnStyleByHeaderBuilder

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

Parameters

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

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 ExcelColumnStyleByHeaderBuilder Date(String pattern = "yyyy-mm-dd") #
Returns: ExcelColumnStyleByHeaderBuilder

Applies a date format using the provided pattern.

Parameters

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

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 ExcelColumnStyleByHeaderBuilder DurationHours() #
Returns: ExcelColumnStyleByHeaderBuilder

Applies a duration format in hours.

public ExcelColumnStyleByHeaderBuilder FontColor(String hexColor) #
Returns: ExcelColumnStyleByHeaderBuilder

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

Parameters

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

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 ExcelColumnStyleByHeaderBuilder Integer() #
Returns: ExcelColumnStyleByHeaderBuilder

Applies an integer number format.

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

Applies a numeric format with optional decimal places.

Parameters

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

Applies a custom number format string.

Parameters

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

Applies a percentage format.

Parameters

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

Applies a text format.

public ExcelColumnStyleByHeaderBuilder Time() #
Returns: ExcelColumnStyleByHeaderBuilder

Applies a time format.