Table of Contents

Interface IXLWorksheet

Namespace
SlapKit.Excel.Excel
Assembly
SlapKit.Excel.dll
public interface IXLWorksheet : IXLRangeBase, IXLAddressable, IXLProtectable<IXLSheetProtection, XLSheetProtectionElements>, IXLProtectable, IXLSheet
Inherited Members
Extension Methods

Properties

ActiveCell 

IXLCell ActiveCell { get; set; }

Property Value

IXLCell

Author 

string Author { get; set; }

Property Value

string

AutoFilter 

IXLAutoFilter AutoFilter { get; }

Property Value

IXLAutoFilter

ColumnWidth

Gets or sets the default column width for this worksheet.

double ColumnWidth { get; set; }

Property Value

double

ConditionalFormats 

IXLConditionalFormats ConditionalFormats { get; }

Property Value

IXLConditionalFormats

DataValidations 

IXLDataValidations DataValidations { get; }

Property Value

IXLDataValidations

MergedRanges 

IXLRanges MergedRanges { get; }

Property Value

IXLRanges

NamedRanges

Gets an object to manage this worksheet's named ranges.

IXLNamedRanges NamedRanges { get; }

Property Value

IXLNamedRanges

Outline

Gets an object to manipulate the Outline levels.

IXLOutline Outline { get; }

Property Value

IXLOutline

PageSetup

Gets an object to manipulate the sheet's print options.

IXLPageSetup PageSetup { get; }

Property Value

IXLPageSetup

PivotTables 

IXLPivotTables PivotTables { get; }

Property Value

IXLPivotTables

RightToLeft 

bool RightToLeft { get; set; }

Property Value

bool

RowHeight

Gets or sets the default row height for this worksheet.

double RowHeight { get; set; }

Property Value

double

SelectedRanges 

IXLRanges SelectedRanges { get; }

Property Value

IXLRanges

SheetView

Gets an object to manage how the sheet is going to be displayed by Excel.

IXLSheetView SheetView { get; }

Property Value

IXLSheetView

ShowFormulas 

bool ShowFormulas { get; set; }

Property Value

bool

ShowGridLines 

bool ShowGridLines { get; set; }

Property Value

bool

ShowOutlineSymbols 

bool ShowOutlineSymbols { get; set; }

Property Value

bool

ShowRowColHeaders 

bool ShowRowColHeaders { get; set; }

Property Value

bool

ShowRuler 

bool ShowRuler { get; set; }

Property Value

bool

ShowWhiteSpace 

bool ShowWhiteSpace { get; set; }

Property Value

bool

ShowZeros 

bool ShowZeros { get; set; }

Property Value

bool

SortColumns 

IXLSortElements SortColumns { get; }

Property Value

IXLSortElements

SortRows 

IXLSortElements SortRows { get; }

Property Value

IXLSortElements

SparklineGroups 

IXLSparklineGroups SparklineGroups { get; }

Property Value

IXLSparklineGroups

TabColor 

XLColor TabColor { get; set; }

Property Value

XLColor

Tables

Gets an object to manage this worksheet's Excel tables

IXLTables Tables { get; }

Property Value

IXLTables

Methods

Cell(IXLAddress)

Gets the cell at the specified address.

IXLCell Cell(IXLAddress cellAddressInRange)

Parameters

cellAddressInRange IXLAddress

The cell address in the worksheet.

Returns

IXLCell

Cell(int, int)

Gets the cell at the specified row and column.

IXLCell Cell(int row, int column)

Parameters

row int

The cell's row.

column int

The cell's column.

Returns

IXLCell

Cell(int, string)

Gets the cell at the specified row and column.

IXLCell Cell(int row, string column)

Parameters

row int

The cell's row.

column string

The cell's column.

Returns

IXLCell

Cell(string)

Gets the cell at the specified address.

IXLCell Cell(string cellAddressInRange)

Parameters

cellAddressInRange string

The cell address in the worksheet.

Returns

IXLCell

CollapseColumns()

Collapses all outlined columns.

IXLWorksheet CollapseColumns()

Returns

IXLWorksheet

CollapseColumns(int)

Collapses the outlined columns of the specified level.

IXLWorksheet CollapseColumns(int outlineLevel)

Parameters

outlineLevel int

The outline level.

Returns

IXLWorksheet

CollapseRows()

Collapses all outlined rows.

IXLWorksheet CollapseRows()

Returns

IXLWorksheet

CollapseRows(int)

Collapses the outlined rows of the specified level.

IXLWorksheet CollapseRows(int outlineLevel)

Parameters

outlineLevel int

The outline level.

Returns

IXLWorksheet

Column(int)

Gets the specified column of the worksheet.

IXLColumn Column(int column)

Parameters

column int

The worksheet's column.

Returns

IXLColumn

Column(string)

Gets the specified column of the worksheet.

IXLColumn Column(string column)

Parameters

column string

The worksheet's column.

Returns

IXLColumn

ColumnCount()

Gets the number of columns in this worksheet.

int ColumnCount()

Returns

int

Columns()

Gets a collection of all columns in this worksheet.

IXLColumns Columns()

Returns

IXLColumns

Columns(int, int)

Gets a collection of the specified columns in this worksheet.

IXLColumns Columns(int firstColumn, int lastColumn)

Parameters

firstColumn int

The first column to return.

lastColumn int

The last column to return.

Returns

IXLColumns

Columns(string)

Gets a collection of the specified columns in this worksheet, separated by commas.

e.g. Columns("G:H"), Columns("10:11,13:14"), Columns("P:Q,S:T"), Columns("V")

IXLColumns Columns(string columns)

Parameters

columns string

The columns to return.

Returns

IXLColumns

Columns(string, string)

Gets a collection of the specified columns in this worksheet.

IXLColumns Columns(string firstColumn, string lastColumn)

Parameters

firstColumn string

The first column to return.

lastColumn string

The last column to return.

Returns

IXLColumns

ColumnsUsed(XLCellsUsedOptions, Func<IXLColumn, bool>) 

IXLColumns ColumnsUsed(XLCellsUsedOptions options = XLCellsUsedOptions.AllContents, Func<IXLColumn, bool> predicate = null)

Parameters

options XLCellsUsedOptions
predicate Func<IXLColumn, bool>

Returns

IXLColumns

ColumnsUsed(Func<IXLColumn, bool>) 

IXLColumns ColumnsUsed(Func<IXLColumn, bool> predicate)

Parameters

predicate Func<IXLColumn, bool>

Returns

IXLColumns

CopyTo(XLWorkbook) 

IXLWorksheet CopyTo(XLWorkbook workbook)

Parameters

workbook XLWorkbook

Returns

IXLWorksheet

CopyTo(XLWorkbook, string)

Copy a worksheet from this workbook to a different workbook as a new sheet.

IXLWorksheet CopyTo(XLWorkbook workbook, string newSheetName)

Parameters

workbook XLWorkbook

Workbook into which copy this sheet.

newSheetName string

Name of new sheet in the workbook where will the data be copied. Sheet will be in the last position.

Returns

IXLWorksheet

Newly created sheet in the workbook.

CopyTo(XLWorkbook, string, int) 

IXLWorksheet CopyTo(XLWorkbook workbook, string newSheetName, int position)

Parameters

workbook XLWorkbook
newSheetName string
position int

Returns

IXLWorksheet

CopyTo(string)

Copies the

IXLWorksheet CopyTo(string newSheetName)

Parameters

newSheetName string

Returns

IXLWorksheet

CopyTo(string, int) 

IXLWorksheet CopyTo(string newSheetName, int position)

Parameters

newSheetName string
position int

Returns

IXLWorksheet

Evaluate(string, string)

Evaluate an formula and return a result.

XLCellValue Evaluate(string expression, string formulaAddress = null)

Parameters

expression string

Formula to evaluate.

formulaAddress string

A cell address that is used to provide context for formula calculation (mostly implicit intersection).

Returns

XLCellValue

Exceptions

MissingContextException

If formulaAddress was needed for some part of calculation.

ExpandColumns()

Expands all outlined columns.

IXLWorksheet ExpandColumns()

Returns

IXLWorksheet

ExpandColumns(int)

Expands the outlined columns of the specified level.

IXLWorksheet ExpandColumns(int outlineLevel)

Parameters

outlineLevel int

The outline level.

Returns

IXLWorksheet

ExpandRows()

Expands all outlined rows.

IXLWorksheet ExpandRows()

Returns

IXLWorksheet

ExpandRows(int)

Expands the outlined rows of the specified level.

IXLWorksheet ExpandRows(int outlineLevel)

Parameters

outlineLevel int

The outline level.

Returns

IXLWorksheet

FirstColumn()

Gets the first column of the worksheet.

IXLColumn FirstColumn()

Returns

IXLColumn

FirstColumnUsed()

Gets the first non-empty column of the worksheet that contains a cell with a value.

IXLColumn FirstColumnUsed()

Returns

IXLColumn

FirstColumnUsed(XLCellsUsedOptions)

Gets the first non-empty column of the worksheet that contains a cell with a value.

IXLColumn FirstColumnUsed(XLCellsUsedOptions options)

Parameters

options XLCellsUsedOptions

The options to determine whether a cell is used.

Returns

IXLColumn

FirstRow()

Gets the first row of the worksheet.

IXLRow FirstRow()

Returns

IXLRow

FirstRowUsed()

Gets the first non-empty row of the worksheet that contains a cell with a value.

Formatted empty cells do not count.

IXLRow FirstRowUsed()

Returns

IXLRow

FirstRowUsed(XLCellsUsedOptions)

Gets the first non-empty row of the worksheet that contains a cell with a value.

IXLRow FirstRowUsed(XLCellsUsedOptions options)

Parameters

options XLCellsUsedOptions

The options to determine whether a cell is used.

Returns

IXLRow

Hide() 

IXLWorksheet Hide()

Returns

IXLWorksheet

LastColumn()

Gets the last column of the worksheet.

IXLColumn LastColumn()

Returns

IXLColumn

LastColumnUsed()

Gets the last non-empty column of the worksheet that contains a cell with a value.

IXLColumn LastColumnUsed()

Returns

IXLColumn

LastColumnUsed(XLCellsUsedOptions)

Gets the last non-empty column of the worksheet that contains a cell with a value.

IXLColumn LastColumnUsed(XLCellsUsedOptions options)

Parameters

options XLCellsUsedOptions

The options to determine whether a cell is used.

Returns

IXLColumn

LastRow()

Gets the last row of the worksheet.

IXLRow LastRow()

Returns

IXLRow

LastRowUsed()

Gets the last non-empty row of the worksheet that contains a cell with a value.

IXLRow LastRowUsed()

Returns

IXLRow

LastRowUsed(XLCellsUsedOptions)

Gets the last non-empty row of the worksheet that contains a cell with a value.

IXLRow LastRowUsed(XLCellsUsedOptions options)

Parameters

options XLCellsUsedOptions

The options to determine whether a cell is used.

Returns

IXLRow

NamedRange(string)

Gets the specified named range.

IXLNamedRange NamedRange(string rangeName)

Parameters

rangeName string

Name of the range.

Returns

IXLNamedRange

PivotTable(string) 

IXLPivotTable PivotTable(string name)

Parameters

name string

Returns

IXLPivotTable

Range(IXLAddress, IXLAddress)

Returns the specified range.

IXLRange Range(IXLAddress firstCellAddress, IXLAddress lastCellAddress)

Parameters

firstCellAddress IXLAddress

The first cell address in the worksheet.

lastCellAddress IXLAddress

The last cell address in the worksheet.

Returns

IXLRange

Range(IXLCell, IXLCell)

Returns the specified range.

IXLRange Range(IXLCell firstCell, IXLCell lastCell)

Parameters

firstCell IXLCell

The first cell in the range.

lastCell IXLCell

The last cell in the range.

Returns

IXLRange

Range(IXLRangeAddress)

Returns the specified range.

IXLRange Range(IXLRangeAddress rangeAddress)

Parameters

rangeAddress IXLRangeAddress

The range boundaries.

Returns

IXLRange

Range(int, int, int, int)

Returns the specified range.

IXLRange Range(int firstCellRow, int firstCellColumn, int lastCellRow, int lastCellColumn)

Parameters

firstCellRow int

The first cell's row of the range to return.

firstCellColumn int

The first cell's column of the range to return.

lastCellRow int

The last cell's row of the range to return.

lastCellColumn int

The last cell's column of the range to return.

Returns

IXLRange

.

Range(string)

Returns the specified range.

IXLRange Range(string rangeAddress)

Parameters

rangeAddress string

The range boundaries.

Returns

IXLRange

Range(string, string)

Returns the specified range.

IXLRange Range(string firstCellAddress, string lastCellAddress)

Parameters

firstCellAddress string

The first cell address in the worksheet.

lastCellAddress string

The last cell address in the worksheet.

Returns

IXLRange

RangeUsed() 

IXLRange RangeUsed()

Returns

IXLRange

RangeUsed(XLCellsUsedOptions) 

IXLRange RangeUsed(XLCellsUsedOptions options)

Parameters

options XLCellsUsedOptions

Returns

IXLRange

Ranges(string)

Returns a collection of ranges, separated by commas.

IXLRanges Ranges(string ranges)

Parameters

ranges string

The ranges to return.

Returns

IXLRanges

RecalculateAllFormulas()

Force recalculation of all cell formulas.

void RecalculateAllFormulas()

Row(int)

Gets the specified row of the worksheet.

IXLRow Row(int row)

Parameters

row int

The worksheet's row.

Returns

IXLRow

RowCount()

Gets the number of rows in this worksheet.

int RowCount()

Returns

int

Rows()

Gets a collection of all rows in this worksheet.

IXLRows Rows()

Returns

IXLRows

Rows(int, int)

Gets a collection of the specified rows in this worksheet.

IXLRows Rows(int firstRow, int lastRow)

Parameters

firstRow int

The first row to return.

lastRow int

The last row to return.

Returns

IXLRows

Rows(string)

Gets a collection of the specified rows in this worksheet, separated by commas.

e.g. Rows("4:5"), Rows("7:8,10:11"), Rows("13")

IXLRows Rows(string rows)

Parameters

rows string

The rows to return.

Returns

IXLRows

RowsUsed(XLCellsUsedOptions, Func<IXLRow, bool>) 

IXLRows RowsUsed(XLCellsUsedOptions options = XLCellsUsedOptions.AllContents, Func<IXLRow, bool> predicate = null)

Parameters

options XLCellsUsedOptions
predicate Func<IXLRow, bool>

Returns

IXLRows

RowsUsed(Func<IXLRow, bool>) 

IXLRows RowsUsed(Func<IXLRow, bool> predicate)

Parameters

predicate Func<IXLRow, bool>

Returns

IXLRows

SetRightToLeft() 

IXLWorksheet SetRightToLeft()

Returns

IXLWorksheet

SetRightToLeft(bool) 

IXLWorksheet SetRightToLeft(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetShowFormulas() 

IXLWorksheet SetShowFormulas()

Returns

IXLWorksheet

SetShowFormulas(bool) 

IXLWorksheet SetShowFormulas(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetShowGridLines() 

IXLWorksheet SetShowGridLines()

Returns

IXLWorksheet

SetShowGridLines(bool) 

IXLWorksheet SetShowGridLines(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetShowOutlineSymbols() 

IXLWorksheet SetShowOutlineSymbols()

Returns

IXLWorksheet

SetShowOutlineSymbols(bool) 

IXLWorksheet SetShowOutlineSymbols(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetShowRowColHeaders() 

IXLWorksheet SetShowRowColHeaders()

Returns

IXLWorksheet

SetShowRowColHeaders(bool) 

IXLWorksheet SetShowRowColHeaders(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetShowRuler() 

IXLWorksheet SetShowRuler()

Returns

IXLWorksheet

SetShowRuler(bool) 

IXLWorksheet SetShowRuler(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetShowWhiteSpace() 

IXLWorksheet SetShowWhiteSpace()

Returns

IXLWorksheet

SetShowWhiteSpace(bool) 

IXLWorksheet SetShowWhiteSpace(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetShowZeros() 

IXLWorksheet SetShowZeros()

Returns

IXLWorksheet

SetShowZeros(bool) 

IXLWorksheet SetShowZeros(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetTabActive() 

IXLWorksheet SetTabActive()

Returns

IXLWorksheet

SetTabActive(bool) 

IXLWorksheet SetTabActive(bool value)

Parameters

value bool

Returns

IXLWorksheet

SetTabColor(XLColor) 

IXLWorksheet SetTabColor(XLColor color)

Parameters

color XLColor

Returns

IXLWorksheet

SetTabSelected() 

IXLWorksheet SetTabSelected()

Returns

IXLWorksheet

SetTabSelected(bool) 

IXLWorksheet SetTabSelected(bool value)

Parameters

value bool

Returns

IXLWorksheet

Sort() 

IXLRange Sort()

Returns

IXLRange

Sort(int, XLSortOrder, bool, bool) 

IXLRange Sort(int columnToSortBy, XLSortOrder sortOrder = XLSortOrder.Ascending, bool matchCase = false, bool ignoreBlanks = true)

Parameters

columnToSortBy int
sortOrder XLSortOrder
matchCase bool
ignoreBlanks bool

Returns

IXLRange

Sort(string, XLSortOrder, bool, bool) 

IXLRange Sort(string columnsToSortBy, XLSortOrder sortOrder = XLSortOrder.Ascending, bool matchCase = false, bool ignoreBlanks = true)

Parameters

columnsToSortBy string
sortOrder XLSortOrder
matchCase bool
ignoreBlanks bool

Returns

IXLRange

SortLeftToRight(XLSortOrder, bool, bool) 

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

Parameters

sortOrder XLSortOrder
matchCase bool
ignoreBlanks bool

Returns

IXLRange

Table(int)

Gets the Excel table of the given index

IXLTable Table(int index)

Parameters

index int

Index of the table to return

Returns

IXLTable

Table(string)

Gets the Excel table of the given name

IXLTable Table(string name)

Parameters

name string

Name of the table to return

Returns

IXLTable

Unhide() 

IXLWorksheet Unhide()

Returns

IXLWorksheet