API Reference

Class

ExcelColumnFormatPlan

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Describes reusable header-based column number formats for worksheet exports.

Inheritance

  • Object
  • ExcelColumnFormatPlan

Usage

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

Accepted by parameters

Constructors

public ExcelColumnFormatPlan() #

Methods

public ExcelColumnFormatPlan Add(String header, ExcelNumberPreset preset, Int32 decimals = 2, CultureInfo culture = null, Boolean includeHeader = false, Boolean autoFit = false) #
Returns: ExcelColumnFormatPlan

Adds a preset number format for a column resolved by header text.

Parameters

header System.String requiredposition: 0
preset OfficeIMO.Excel.ExcelNumberPreset requiredposition: 1
decimals System.Int32 = 2 optionalposition: 2
culture System.Globalization.CultureInfo = null optionalposition: 3
includeHeader System.Boolean = false optionalposition: 4
autoFit System.Boolean = false optionalposition: 5
public ExcelColumnFormatPlan AddFormat(String header, String numberFormat, Boolean includeHeader = false, Boolean autoFit = false) #
Returns: ExcelColumnFormatPlan

Adds a custom Excel number format for a column resolved by header text.

Parameters

header System.String requiredposition: 0
numberFormat System.String requiredposition: 1
includeHeader System.Boolean = false optionalposition: 2
autoFit System.Boolean = false optionalposition: 3
Currency 4 overloads
public ExcelColumnFormatPlan Currency(params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds currency formatting for columns resolved by header text.

Parameters

headers System.String[] requiredposition: 0
public ExcelColumnFormatPlan Currency(CultureInfo culture, params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds culture-aware currency formatting for columns resolved by header text.

Parameters

culture System.Globalization.CultureInfo requiredposition: 0
headers System.String[] requiredposition: 1
public ExcelColumnFormatPlan Currency(Int32 decimals, params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds currency formatting with explicit precision for columns resolved by header text.

Parameters

decimals System.Int32 requiredposition: 0
headers System.String[] requiredposition: 1
public ExcelColumnFormatPlan Currency(Int32 decimals, CultureInfo culture, params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds culture-aware currency formatting with explicit precision for columns resolved by header text.

Parameters

decimals System.Int32 requiredposition: 0
culture System.Globalization.CultureInfo requiredposition: 1
headers System.String[] requiredposition: 2
public ExcelColumnFormatPlan Date(params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds date formatting for columns resolved by header text.

Parameters

headers System.String[] requiredposition: 0
public ExcelColumnFormatPlan DateTime(params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds date and time formatting for columns resolved by header text.

Parameters

headers System.String[] requiredposition: 0
public ExcelColumnFormatPlan Integer(params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds integer formatting for columns resolved by header text.

Parameters

headers System.String[] requiredposition: 0
Number 2 overloads
public ExcelColumnFormatPlan Number(params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds decimal number formatting for columns resolved by header text.

Parameters

headers System.String[] requiredposition: 0
public ExcelColumnFormatPlan Number(Int32 decimals, params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds decimal number formatting with explicit precision for columns resolved by header text.

Parameters

decimals System.Int32 requiredposition: 0
headers System.String[] requiredposition: 1
Percent 2 overloads
public ExcelColumnFormatPlan Percent(params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds percent formatting for columns resolved by header text.

Parameters

headers System.String[] requiredposition: 0
public ExcelColumnFormatPlan Percent(Int32 decimals, params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds percent formatting with explicit precision for columns resolved by header text.

Parameters

decimals System.Int32 requiredposition: 0
headers System.String[] requiredposition: 1
public ExcelColumnFormatPlan Text(params String[] headers) #
Returns: ExcelColumnFormatPlan

Adds text formatting for columns resolved by header text.

Parameters

headers System.String[] requiredposition: 0

Properties

public IReadOnlyList<ExcelColumnFormatRule> Rules { get; } #

Gets the configured column format rules.

public Int32 Count { get; } #

Gets the number of configured rules.