Class ExcelDataProvider

This class should be implemented to be able to deliver excel data to the formula parser.

Inheritance

System.Object

ExcelDataProvider

EpplusExcelDataProvider

Implements

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.FormulaParsing

Assembly: EPPlus.dll

Syntax

public abstract class ExcelDataProvider : IDisposable

Properties

ExcelMaxColumns

Max number of columns in a worksheet that the Excel data provider can handle.

Declaration

public abstract int ExcelMaxColumns { get; }

Property Value

Type	Description
System.Int32

ExcelMaxRows

Max number of rows in a worksheet that the Excel data provider can handle

Declaration

public abstract int ExcelMaxRows { get; }

Property Value

Type	Description
System.Int32

Methods

Dispose()

Use this method to free unmanaged resources.

Declaration

public abstract void Dispose()

GetCellId(String, Int32, Int32)

Creates a cell id, representing the full address of a cell.

Declaration

public abstract ulong GetCellId(string sheetName, int row, int col)

Parameters

Type	Name	Description
System.String	sheetName	Name of the worksheet
System.Int32	row	Row ix
System.Int32	col	Column Index

Returns

Type	Description
System.UInt64	An System.UInt64 representing the addrss

GetCellValue(String, Int32, Int32)

Returns a single cell value

Declaration

public abstract object GetCellValue(string sheetName, int row, int col)

Parameters

Type	Name	Description
System.String	sheetName
System.Int32	row
System.Int32	col

Returns

Type	Description
System.Object

GetDimensionEnd(String)

Returns the address of the lowest rightmost cell on the worksheet.

Declaration

public abstract ExcelCellAddress GetDimensionEnd(string worksheet)

Parameters

Type	Name	Description
System.String	worksheet

Returns

Type	Description
ExcelCellAddress

GetExcelTable(String)

Declaration

public abstract ExcelTable GetExcelTable(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
ExcelTable

GetFormat(Object, String)

Declaration

public abstract string GetFormat(object value, string format)

Parameters

Type	Name	Description
System.Object	value
System.String	format

Returns

Type	Description
System.String

GetName(String, String)

Declaration

public abstract ExcelDataProvider.INameInfo GetName(string worksheet, string name)

Parameters

Type	Name	Description
System.String	worksheet
System.String	name

Returns

Type	Description
ExcelDataProvider.INameInfo

GetRange(String, Int32, Int32, Int32, Int32)

Declaration

public abstract ExcelDataProvider.IRangeInfo GetRange(string worksheet, int fromRow, int fromCol, int toRow, int toCol)

Parameters

Type	Name	Description
System.String	worksheet
System.Int32	fromRow
System.Int32	fromCol
System.Int32	toRow
System.Int32	toCol

Returns

Type	Description
ExcelDataProvider.IRangeInfo

GetRange(String, Int32, Int32, String)

Returns values from the required range.

Declaration

public abstract ExcelDataProvider.IRangeInfo GetRange(string worksheetName, int row, int column, string address)

Parameters

Type	Name	Description
System.String	worksheetName	The name of the worksheet
System.Int32	row	Row
System.Int32	column	Column
System.String	address	The reference address

Returns

Type	Description
ExcelDataProvider.IRangeInfo

GetRange(String, String)

Returns values from the required range.

Declaration

public abstract ExcelDataProvider.IRangeInfo GetRange(string worksheetName, string address)

Parameters

Type	Name	Description
System.String	worksheetName	The name of the worksheet
System.String	address	The reference address

Returns

Type	Description
ExcelDataProvider.IRangeInfo

GetRangeFormula(String, Int32, Int32)

Declaration

public abstract string GetRangeFormula(string worksheetName, int row, int column)

Parameters

Type	Name	Description
System.String	worksheetName
System.Int32	row
System.Int32	column

Returns

Type	Description
System.String

GetRangeFormulaTokens(String, Int32, Int32)

Declaration

public abstract List<Token> GetRangeFormulaTokens(string worksheetName, int row, int column)

Parameters

Type	Name	Description
System.String	worksheetName
System.Int32	row
System.Int32	column

Returns

Type	Description
System.Collections.Generic.List<Token>

GetRangeValue(String, Int32, Int32)

Declaration

public abstract object GetRangeValue(string worksheetName, int row, int column)

Parameters

Type	Name	Description
System.String	worksheetName
System.Int32	row
System.Int32	column

Returns

Type	Description
System.Object

GetRangeValues(String)

Declaration

public abstract IEnumerable<object> GetRangeValues(string address)

Parameters

Type	Name	Description
System.String	address

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.Object>

GetWorkbookNameValues()

Returns all defined names in a workbook

Declaration

public abstract ExcelNamedRangeCollection GetWorkbookNameValues()

Returns

Type	Description
ExcelNamedRangeCollection

GetWorksheetIndex(String)

Returns the number of a worksheet in the workbook

Declaration

public abstract int GetWorksheetIndex(string worksheetName)

Parameters

Type	Name	Description
System.String	worksheetName	Name of the worksheet

Returns

Type	Description
System.Int32	The number within the workbook

GetWorksheetNames(String)

Returns the names of all worksheet names

Declaration

public abstract ExcelNamedRangeCollection GetWorksheetNames(string worksheet)

Parameters

Type	Name	Description
System.String	worksheet

Returns

Type	Description
ExcelNamedRangeCollection

GetWorksheets()

Returns the names of the worksheets in a workbook

Declaration

public abstract IEnumerable<string> GetWorksheets()

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>

IsExternalName(String)

Returns the names of all worksheet names

Declaration

public abstract bool IsExternalName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IsRowHidden(String, Int32)

Declaration

public abstract bool IsRowHidden(string worksheetName, int row)

Parameters

Type	Name	Description
System.String	worksheetName
System.Int32	row

Returns

Type	Description
System.Boolean

Reset()

Declaration

public abstract void Reset()

Implements

System.IDisposable