Table of Contents

Interface IXLRow

Namespace
SlapKit.Excel.Excel
Assembly
SlapKit.Excel.dll
public interface IXLRow : IXLRangeBase, IXLAddressable
Inherited Members
Extension Methods

Properties

Height

Gets or sets the height of this row.

double Height { get; set; }

Property Value

double

The width of this row in points.

IsHidden

Gets a value indicating whether this row is hidden or not.

bool IsHidden { get; }

Property Value

bool

true if this row is hidden; otherwise, false.

OutlineLevel

Gets or sets the outline level of this row.

int OutlineLevel { get; set; }

Property Value

int

The outline level of this row.

Methods

AddHorizontalPageBreak()

Adds a horizontal page break after this row.

IXLRow AddHorizontalPageBreak()

Returns

IXLRow

AdjustToContents() 

IXLRow AdjustToContents()

Returns

IXLRow

AdjustToContents(double, double) 

IXLRow AdjustToContents(double minHeight, double maxHeight)

Parameters

minHeight double
maxHeight double

Returns

IXLRow

AdjustToContents(int)

Adjusts the height of the row based on its contents, starting from the startColumn.

IXLRow AdjustToContents(int startColumn)

Parameters

startColumn int

The column to start calculating the row height.

Returns

IXLRow

AdjustToContents(int, double, double) 

IXLRow AdjustToContents(int startColumn, double minHeight, double maxHeight)

Parameters

startColumn int
minHeight double
maxHeight double

Returns

IXLRow

AdjustToContents(int, int)

Adjusts the height of the row based on its contents, starting from the startColumn and ending at endColumn.

IXLRow AdjustToContents(int startColumn, int endColumn)

Parameters

startColumn int

The column to start calculating the row height.

endColumn int

The column to end calculating the row height.

Returns

IXLRow

AdjustToContents(int, int, double, double)

Adjust height of the column according to the content of the cells.

IXLRow AdjustToContents(int startColumn, int endColumn, double minHeightPt, double maxHeightPt)

Parameters

startColumn int

Number of a first column whose content is considered.

endColumn int

Number of a last column whose content is considered.

minHeightPt double

Minimum height of adjusted column, in points.

maxHeightPt double

Maximum height of adjusted column, in points.

Returns

IXLRow

Cell(int)

Gets the cell in the specified column.

IXLCell Cell(int columnNumber)

Parameters

columnNumber int

The cell's column.

Returns

IXLCell

Cell(string)

Gets the cell in the specified column.

IXLCell Cell(string columnLetter)

Parameters

columnLetter string

The cell's column.

Returns

IXLCell

CellCount() 

int CellCount()

Returns

int

Cells(int, int)

Returns the specified group of cells.

IXLCells Cells(int firstColumn, int lastColumn)

Parameters

firstColumn int

The first column in the group of cells to return.

lastColumn int

The last column in the group of cells to return.

Returns

IXLCells

Cells(string)

Returns the specified group of cells, separated by commas.

e.g. Cells("1"), Cells("1:5"), Cells("1,3:5")

IXLCells Cells(string cellsInRow)

Parameters

cellsInRow string

The row's cells to return.

Returns

IXLCells

Cells(string, string)

Returns the specified group of cells.

IXLCells Cells(string firstColumn, string lastColumn)

Parameters

firstColumn string

The first column in the group of cells to return.

lastColumn string

The last column in the group of cells to return.

Returns

IXLCells

Clear(XLClearOptions)

Clears the contents of this row.

IXLRow Clear(XLClearOptions clearOptions = XLClearOptions.All)

Parameters

clearOptions XLClearOptions

Specify what you want to clear.

Returns

IXLRow

ClearHeight()

Clears the height for the row and defaults it to the spreadsheet row height.

void ClearHeight()

Collapse()

Show this row as collapsed.

IXLRow Collapse()

Returns

IXLRow

CopyTo(IXLCell) 

IXLRangeRow CopyTo(IXLCell cell)

Parameters

cell IXLCell

Returns

IXLRangeRow

CopyTo(IXLRangeBase) 

IXLRangeRow CopyTo(IXLRangeBase range)

Parameters

range IXLRangeBase

Returns

IXLRangeRow

CopyTo(IXLRow) 

IXLRow CopyTo(IXLRow row)

Parameters

row IXLRow

Returns

IXLRow

Delete()

Deletes this row and shifts the rows below this one accordingly.

void Delete()

Remarks

Don't use in a loop due to poor performance. Use Delete(XLShiftDeletedCells) instead.

Expand()

Expands this row (if it's collapsed).

IXLRow Expand()

Returns

IXLRow

Group()

Adds this row to the next outline level (Increments the outline level for this row by 1).

IXLRow Group()

Returns

IXLRow

Group(bool)

Adds this row to the next outline level (Increments the outline level for this row by 1).

IXLRow Group(bool collapse)

Parameters

collapse bool

If set to true the row will be shown collapsed.

Returns

IXLRow

Group(int)

Sets outline level for this row.

IXLRow Group(int outlineLevel)

Parameters

outlineLevel int

The outline level.

Returns

IXLRow

Group(int, bool)

Sets outline level for this row.

IXLRow Group(int outlineLevel, bool collapse)

Parameters

outlineLevel int

The outline level.

collapse bool

If set to true the row will be shown collapsed.

Returns

IXLRow

Hide()

Hides this row.

IXLRow Hide()

Returns

IXLRow

InsertRowsAbove(int)

Inserts X number of rows above this one.

This row and all below will be shifted accordingly.

IXLRows InsertRowsAbove(int numberOfRows)

Parameters

numberOfRows int

The number of rows to insert.

Returns

IXLRows

InsertRowsBelow(int)

Inserts X number of rows below this one.

All rows below will be shifted accordingly.

IXLRows InsertRowsBelow(int numberOfRows)

Parameters

numberOfRows int

The number of rows to insert.

Returns

IXLRows

Row(IXLCell, IXLCell) 

IXLRangeRow Row(IXLCell start, IXLCell end)

Parameters

start IXLCell
end IXLCell

Returns

IXLRangeRow

Row(int, int) 

IXLRangeRow Row(int start, int end)

Parameters

start int
end int

Returns

IXLRangeRow

RowAbove() 

IXLRow RowAbove()

Returns

IXLRow

RowAbove(int) 

IXLRow RowAbove(int step)

Parameters

step int

Returns

IXLRow

RowBelow() 

IXLRow RowBelow()

Returns

IXLRow

RowBelow(int) 

IXLRow RowBelow(int step)

Parameters

step int

Returns

IXLRow

RowNumber()

Gets this row's number

int RowNumber()

Returns

int

RowUsed(XLCellsUsedOptions) 

IXLRangeRow RowUsed(XLCellsUsedOptions options = XLCellsUsedOptions.AllContents)

Parameters

options XLCellsUsedOptions

Returns

IXLRangeRow

Rows(string) 

IXLRangeRows Rows(string columns)

Parameters

columns string

Returns

IXLRangeRows

Sort() 

IXLRow Sort()

Returns

IXLRow

SortLeftToRight(XLSortOrder, bool, bool) 

IXLRow SortLeftToRight(XLSortOrder sortOrder = XLSortOrder.Ascending, bool matchCase = false, bool ignoreBlanks = true)

Parameters

sortOrder XLSortOrder
matchCase bool
ignoreBlanks bool

Returns

IXLRow

Ungroup()

Adds this row to the previous outline level (decrements the outline level for this row by 1).

IXLRow Ungroup()

Returns

IXLRow

Ungroup(bool)

Adds this row to the previous outline level (decrements the outline level for this row by 1).

IXLRow Ungroup(bool fromAll)

Parameters

fromAll bool

If set to true it will remove this row from all outline levels.

Returns

IXLRow

Unhide()

Unhides this row.

IXLRow Unhide()

Returns

IXLRow