Class ExcelRangeRow

Represents a range of rows

Inheritance

System.Object

ExcelRangeRow

ExcelRowsCollection

Implements

System.Collections.Generic.IEnumerable<ExcelRangeRow>

System.Collections.IEnumerable

System.Collections.Generic.IEnumerator<ExcelRangeRow>

System.Collections.IEnumerator

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OfficeOpenXml

Assembly: EPPlus.dll

Syntax

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

Properties

Collapsed

If the row is collapsed in outline mode

Declaration

public bool Collapsed { get; set; }

Property Value

Type	Description
System.Boolean

Current

The current row object in the iteration

Declaration

public ExcelRangeRow Current { get; }

Property Value

Type	Description
ExcelRangeRow

CustomHeight

True if the row Height has been manually set.

Declaration

public bool CustomHeight { get; set; }

Property Value

Type	Description
System.Boolean

EndRow

The last row in the collection

Declaration

public int EndRow { get; }

Property Value

Type	Description
System.Int32

Height

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

Declaration

public double Height { get; set; }

Property Value

Type	Description
System.Double

Hidden

If the row is hidden.

Declaration

public bool Hidden { get; set; }

Property Value

Type	Description
System.Boolean

OutlineLevel

Outline level. Zero if no outline

Declaration

public int OutlineLevel { get; set; }

Property Value

Type	Description
System.Int32

PageBreak

Adds a manual page break after the column.

Declaration

public bool PageBreak { get; set; }

Property Value

Type	Description
System.Boolean

Phonetic

True if the row should show phonetic

Declaration

public bool Phonetic { get; set; }

Property Value

Type	Description
System.Boolean

Range

Reference to the cell range of the row(s)

Declaration

public ExcelRangeBase Range { get; }

Property Value

Type	Description
ExcelRangeBase

StartRow

The first row in the collection

Declaration

public int StartRow { get; }

Property Value

Type	Description
System.Int32

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.

Declaration

public ExcelStyle Style { get; }

Property Value

Type	Description
ExcelStyle

StyleID

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

Declaration

public int StyleID { get; set; }

Property Value

Type	Description
System.Int32

StyleName

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

Declaration

public string StyleName { get; set; }

Property Value

Type	Description
System.String

Methods

CollapseChildren(Boolean)

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

Declaration

public void CollapseChildren(bool allLevels = true)

Parameters

Type	Name	Description
System.Boolean	allLevels

Dispose()

Disposes this object

Declaration

public void Dispose()

ExpandChildren(Boolean)

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

Declaration

public void ExpandChildren(bool allLevels = true)

Parameters

Type	Name	Description
System.Boolean	allLevels

GetEnumerator()

Gets the enumerator

Declaration

public IEnumerator<ExcelRangeRow> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<ExcelRangeRow>

Group()

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

Declaration

public void Group()

MoveNext()

Iterate to the next row

Declaration

public bool MoveNext()

Returns

Type	Description
System.Boolean	False if no more row exists

Reset()

Reset the enumerator

Declaration

public void Reset()

SetVisibleOutlineLevel(Int32, Boolean)

Expands the rows to the OutlineLevel supplied.

Declaration

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

Parameters

Type	Name	Description
System.Int32	level	Expand all rows with a OutlineLevel Equal or Greater than this number.
System.Boolean	collapseChildren	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.

Declaration

public void Ungroup()

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Gets the enumerator

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

IEnumerator.Current

The current row object in the iteration

Declaration

object IEnumerator.Current { get; }

Returns

Type	Description
System.Object

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

System.Collections.Generic.IEnumerator<T>

System.Collections.IEnumerator

System.IDisposable