Class ExcelRangeRow

Namespace

OfficeOpenXml

Assembly

EPPlus.dll

Represents a range of rows

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

Inheritance

object

ExcelRangeRow

Implements

IEnumerable<ExcelRangeRow>

IEnumerable

IEnumerator<ExcelRangeRow>

IEnumerator

IDisposable

Derived

ExcelRowsCollection

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Collapsed

If the row is collapsed in outline mode

public bool Collapsed { get; set; }

Property Value

bool

Current

The current row object in the iteration

public ExcelRangeRow Current { get; }

Property Value

ExcelRangeRow

CustomHeight

True if the row Height has been manually set.

public bool CustomHeight { get; set; }

Property Value

bool

EndRow

The last row in the collection

public int EndRow { get; }

Property Value

int

Height

Row height in points. Setting this property will also set CustomHeight to true.

public double Height { get; set; }

Property Value

double

Hidden

If the row is hidden.

public bool Hidden { get; set; }

Property Value

bool

OutlineLevel

Outline level. Zero if no outline

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 row should show phonetic

public bool Phonetic { get; set; }

Property Value

bool

Range

Reference to the cell range of the row(s)

public ExcelRangeBase Range { get; }

Property Value

ExcelRangeBase

StartRow

The first row in the collection

public int StartRow { get; }

Property Value

int

Style

The Style applied to the whole row(s). Only effects cells with no individual style set. Use the 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 row using a style name.

public string StyleName { get; set; }

Property Value

string

Methods

CollapseChildren(bool)

Collapses and hides the rows's children. Children are rows immegetaly below or top of the row depending on the OutLineSummaryBelow allLevels

public void CollapseChildren(bool allLevels = true)

Parameters

allLevels bool

Dispose()

Disposes this object

public void Dispose()

ExpandChildren(bool)

Expands and shows the rows's children. Children are columns immegetaly below or top of the row depending on the OutLineSummaryBelow allLevels

public void ExpandChildren(bool allLevels = true)

Parameters

allLevels bool

GetEnumerator()

Gets the enumerator

public IEnumerator<ExcelRangeRow> GetEnumerator()

Returns

IEnumerator<ExcelRangeRow>

Group()

Groups the rows using an outline. Adds one to OutlineLevel for each row 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

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

collapseChildren bool

Collapse all children with a greater OutlineLevel than level

Ungroup()

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

public void Ungroup()