Class ExcelRangeColumn¶

Namespace: OfficeOpenXml
Assembly: EPPlus.dll

Represents a range of columns

public class ExcelRangeColumn : IEnumerable<ExcelRangeColumn>, IEnumerable, IEnumerator<ExcelRangeColumn>, IEnumerator, IDisposable

Inheritance¶

object ← ExcelRangeColumn

Derived¶

ExcelColumnCollection

Implements¶

IDisposable
IEnumerable
IEnumerable<ExcelRangeColumn>
IEnumerator
IEnumerator<ExcelRangeColumn>

Inherited Members¶

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties¶

BestFit¶

Indicates that the column should resize when numbers are entered into the column to fit the size of the text. This only applies to columns where the size has not been set.

public bool BestFit { get; set; }

Property Value¶

bool

Collapsed¶

If the column is collapsed in outline mode

public bool Collapsed { get; set; }

Property Value¶

bool

Current¶

The current range when enumerating

public ExcelRangeColumn Current { get; }

Property Value¶

ExcelRangeColumn

EndColumn¶

The last column in the collection

public int EndColumn { get; }

Property Value¶

int

Hidden¶

If the column is hidden.

public bool Hidden { get; set; }

Property Value¶

bool

OutlineLevel¶

Outline level. Zero if no outline. Can not be negative.

public int OutlineLevel { get; set; }

Property Value¶

int

PageBreak¶

Adds a manual page break after the column.

public bool PageBreak { get; set; }

Property Value¶

bool

Phonetic¶

True if the column should show phonetic

public bool Phonetic { get; set; }

Property Value¶

bool

Range¶

Reference to the cell range of the column(s)

public ExcelRangeBase Range { get; }

Property Value¶

ExcelRangeBase

StartColumn¶

The first column in the collection

public int StartColumn { get; }

Property Value¶

int

Style¶

The Style applied to the whole column(s). Only effects cells with no individual style set. Use Range object if you want to set specific styles.

public ExcelStyle Style { get; }

Property Value¶

ExcelStyle

StyleID¶

Sets the style for the entire column using the style ID.

public int StyleID { get; set; }

Property Value¶

int

StyleName¶

Sets the style for the entire column using a style name.

public string StyleName { get; set; }

Property Value¶

string

Width¶

Row width of the column.

public double Width { get; set; }

Property Value¶

double

Methods¶

AutoFit()¶

Set the column width from the content of the range. Columns outside of the worksheets dimension are ignored. The minimum width is the value of the ExcelWorksheet.defaultColumnWidth property.

public void AutoFit()

Remarks¶

Cells containing formulas must be calculated before autofit is called. Wrapped and merged cells are also ignored.

AutoFit(double)¶

Set the column width from the content of the range. Columns outside of the worksheets dimension are ignored.

public void AutoFit(double MinimumWidth)

Parameters¶

MinimumWidth double

Minimum column width

Remarks¶

This method will not work if you run in an environment that does not support GDI. Cells containing formulas are ignored if no calculation is made. Wrapped and merged cells are also ignored.

AutoFit(double, double)¶

Set the column width from the content of the range. Columns outside of the worksheets dimension are ignored.

public void AutoFit(double MinimumWidth, double MaximumWidth)

Parameters¶

MinimumWidth double

Minimum column width

MaximumWidth double

Maximum column width

Remarks¶

This method will not work if you run in an environment that does not support GDI. Cells containing formulas are ignored if no calculation is made. Wrapped and merged cells are also ignored.

CollapseChildren(bool)¶

Collapses and hides the column's children. Children are columns immegetaly to the right or left of the column depending on the OutLineSummaryRight allLevels

public void CollapseChildren(bool allLevels = true)

Parameters¶

allLevels bool

Dispose()¶

Disposes this object

public void Dispose()

ExpandChildren(bool)¶

Expands and shows the column's children. Children are columns immegetaly to the right or left of the column depending on the OutLineSummaryRight allLevels

public void ExpandChildren(bool allLevels = true)

Parameters¶

allLevels bool

GetEnumerator()¶

Gets the enumerator

public IEnumerator<ExcelRangeColumn> GetEnumerator()

Returns¶

IEnumerator<ExcelRangeColumn>

Group()¶

Groups the columns using an outline. Adds one to OutlineLevel for each column if the outline level is less than 8.

public void Group()

MoveNext()¶

Iterate to the next row

public bool MoveNext()

Returns¶

bool

False if no more row exists

Reset()¶

Reset the enumerator

public void Reset()

SetVisibleOutlineLevel(int, bool)¶

Expands the rows to the OutlineLevel supplied.

public void SetVisibleOutlineLevel(int level, bool collapseChildren = true)

Parameters¶

level int

Expands all rows with a OutlineLevel Equal or Greater than this number.

collapseChildren bool

Collapses all children with a greater OutlineLevel than level

UnGroup()¶

Ungroups the columns from the outline. Subtracts one from OutlineLevel for each column if the outline level is larger that zero.

public void UnGroup()