ExcelColumnFormatPlan
OfficeIMO.Excel
Describes reusable header-based column number formats for worksheet exports.
Inheritance
- object
- ExcelColumnFormatPlan
Usage
Explore 11 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 10
- Method ExcelColumnFormatPlan.Add
- Method ExcelColumnFormatPlan.AddFormat
- Method ExcelColumnFormatPlan.Currency
- Method ExcelColumnFormatPlan.Date
- Method ExcelColumnFormatPlan.DateTime
- Method ExcelColumnFormatPlan.Integer
- Method ExcelColumnFormatPlan.Number
- Method ExcelColumnFormatPlan.Percent
- Method ExcelColumnFormatPlan.Text
- Property ExcelWriterOptions.ColumnFormat
Accepted by parameters 1
Constructors
public ExcelColumnFormatPlan() #Methods
public ExcelColumnFormatPlan Add(string header, ExcelNumberPreset preset, int decimals = 2, CultureInfo? culture = null, bool includeHeader = false, bool autoFit = false) #Adds a preset number format for a column resolved by header text.
Parameters
- header string
- preset OfficeIMO.Excel.ExcelNumberPreset
- decimals int = 2
- culture System.Globalization.CultureInfo? = null
- includeHeader bool = false
- autoFit bool = false
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan AddFormat(string header, string numberFormat, bool includeHeader = false, bool autoFit = false) #Adds a custom Excel number format for a column resolved by header text.
Parameters
- header string
- numberFormat string
- includeHeader bool = false
- autoFit bool = false
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Currency(params string[] headers) #Adds currency formatting for columns resolved by header text.
Parameters
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Currency(CultureInfo? culture, params string[] headers) #Adds culture-aware currency formatting for columns resolved by header text.
Parameters
- culture System.Globalization.CultureInfo?
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Currency(int decimals, params string[] headers) #Adds currency formatting with explicit precision for columns resolved by header text.
Parameters
- decimals int
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Currency(int decimals, CultureInfo? culture, params string[] headers) #Adds culture-aware currency formatting with explicit precision for columns resolved by header text.
Parameters
- decimals int
- culture System.Globalization.CultureInfo?
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Date(params string[] headers) #Adds date formatting for columns resolved by header text.
Parameters
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan DateTime(params string[] headers) #Adds date and time formatting for columns resolved by header text.
Parameters
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Integer(params string[] headers) #Adds integer formatting for columns resolved by header text.
Parameters
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Number(params string[] headers) #Adds decimal number formatting for columns resolved by header text.
Parameters
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Number(int decimals, params string[] headers) #Adds decimal number formatting with explicit precision for columns resolved by header text.
Parameters
- decimals int
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Percent(params string[] headers) #Adds percent formatting for columns resolved by header text.
Parameters
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Percent(int decimals, params string[] headers) #Adds percent formatting with explicit precision for columns resolved by header text.
Parameters
- decimals int
- headers string[]
Returns
ExcelColumnFormatPlanpublic ExcelColumnFormatPlan Text(params string[] headers) #Adds text formatting for columns resolved by header text.
Parameters
- headers string[]
Returns
ExcelColumnFormatPlanInherited Methods
Properties
public IReadOnlyList<ExcelColumnFormatRule> Rules { get; } #Gets the configured column format rules.