Table of Contents

Class ExcelRangeBase

Namespace
OfficeOpenXml
Assembly
EPPlus.dll

A range of cells

public class ExcelRangeBase : ExcelAddress, IEnumerable<ExcelRangeBase>, IEnumerable, IEnumerator<ExcelRangeBase>, IDisposable, IEnumerator
Inheritance
ExcelRangeBase
Implements
Derived
Inherited Members
Extension Methods

Fields

_rtc

The richtext collection

protected ExcelRichTextCollection _rtc

Field Value

ExcelRichTextCollection

_worksheet

Reference to the worksheet

protected ExcelWorksheet _worksheet

Field Value

ExcelWorksheet

Properties

AutoFilter

Set an autofilter for the range

public bool AutoFilter { get; set; }

Property Value

bool

Comment

Returns the comment object of the first cell in the range

public ExcelComment Comment { get; }

Property Value

ExcelComment

ConditionalFormatting

Conditional Formatting for this range.

public IRangeConditionalFormatting ConditionalFormatting { get; }

Property Value

IRangeConditionalFormatting

Current

The current range when enumerating

public ExcelRangeBase Current { get; }

Property Value

ExcelRangeBase

DataValidation

Data validation for this range.

public IRangeDataValidation DataValidation { get; }

Property Value

IRangeDataValidation

EntireColumn

A reference to the column properties for column(s= referenced by this range. If multiple ranges are addressed (e.g a1:a2,c1:c3), only the first address is used.

public ExcelRangeColumn EntireColumn { get; }

Property Value

ExcelRangeColumn

EntireRow

A reference to the row properties for row(s) referenced by this range. If multiple ranges are addressed (e.g a1:a2,c1:c3), only the first address is used.

public ExcelRangeRow EntireRow { get; }

Property Value

ExcelRangeRow

Formula

Gets or sets a formula for a range.

public virtual string Formula { get; set; }

Property Value

string

FormulaR1C1

Gets or Set a formula in R1C1 format.

public string FormulaR1C1 { get; set; }

Property Value

string

FormulaRange

The output range of the formula in the top-left cell of the range. A shared formula will return the range for the entire series. An array formula will return the range of the output of the formula. If you want the range of a dynamic array formula, you must calculate the formula first.

public ExcelRangeBase FormulaRange { get; }

Property Value

ExcelRangeBase

The range the formula

FullAddress

Address including sheet name

public string FullAddress { get; }

Property Value

string

FullAddressAbsolute

Address including sheetname

public string FullAddressAbsolute { get; }

Property Value

string

Set the Hyperlink property for a range of cells

public Uri Hyperlink { get; set; }

Property Value

Uri

IsArrayFormula

Is the range a part of an Arrayformula

public bool IsArrayFormula { get; }

Property Value

bool

IsRichText

If the value is in richtext format.

public bool IsRichText { get; set; }

Property Value

bool

IsTable

Returns true if the range is a table. If the range partly matches a table range false will be returned. IsTable

public bool IsTable { get; }

Property Value

bool

Merge

If the cells in the range are merged.

public bool Merge { get; set; }

Property Value

bool

RichText

The cell value is rich text formatted. The RichText-property only apply to the left-top cell of the range.

public ExcelRichTextCollection RichText { get; }

Property Value

ExcelRichTextCollection

Style

The style object for the range.

public ExcelStyle Style { get; }

Property Value

ExcelStyle

StyleID

The style ID. It is not recomended to use this one. Use Named styles as an alternative. If you do, make sure that you use the Style.UpdateXml() method to update any new styles added to the workbook.

public int StyleID { get; set; }

Property Value

int

StyleName

The named style

public string StyleName { get; set; }

Property Value

string

Text

Returns the formatted value.

public string Text { get; }

Property Value

string

ThreadedComment

Returns the threaded comment object of the first cell in the range

public ExcelThreadedCommentThread ThreadedComment { get; }

Property Value

ExcelThreadedCommentThread

UseImplicitItersection

If the formula in the single cell returns an array, implicit intersection will be used instead of creating a dynamic array formula. Please note that this property must be set after setting the formula, as default behaviour is to create a dynamic array formula. Shared formulas will always use implicit intersection.

public bool UseImplicitItersection { get; set; }

Property Value

bool

Value

Set the range to a specific value

public object Value { get; set; }

Property Value

object

Worksheet

WorkSheet object

public ExcelWorksheet Worksheet { get; }

Property Value

ExcelWorksheet

Methods

AddComment(string, string)

Adds a new comment for the range. If this range contains more than one cell, the top left comment is returned by the method.

public ExcelComment AddComment(string Text, string Author = null)

Parameters

Text string

The text for the comment

Author string

The author for the comment. If this property is null or blank EPPlus will set it to the identity of the ClaimsPrincipal if available otherwise to "Anonymous"

Returns

ExcelComment

A reference comment of the top left cell

AddThreadedComment()

Adds a new threaded comment for the range. If this range contains more than one cell, the top left comment is returned by the method.

public ExcelThreadedCommentThread AddThreadedComment()

Returns

ExcelThreadedCommentThread

A reference comment of the top left cell

AutoFitColumns()

Set the column width from the content of the range. Columns outside of the worksheets dimension are ignored. The minimum width is the value of the ExcelWorksheet.defaultColumnWidth property.

public void AutoFitColumns()

Remarks

Cells containing formulas must be calculated before autofit is called. Wrapped and merged cells are also ignored.

AutoFitColumns(double)

Set the column width from the content of the range. Columns outside of the worksheets dimension are ignored.

public void AutoFitColumns(double MinimumWidth)

Parameters

MinimumWidth double

Minimum column width

Remarks

This method will not work if you run in an environment that does not support GDI. Cells containing formulas are ignored if no calculation is made. Wrapped and merged cells are also ignored.

AutoFitColumns(double, double)

Set the column width from the content of the range. Columns outside of the worksheets dimension are ignored.

public void AutoFitColumns(double MinimumWidth, double MaximumWidth)

Parameters

MinimumWidth double

Minimum column width

MaximumWidth double

Maximum column width

Remarks

This method will not work if you run in an environment that does not support GDI. Cells containing formulas are ignored if no calculation is made. Wrapped and merged cells are also ignored.

ChangeAddress()

On change address handler

protected override void ChangeAddress()

Clear()

Clear all cells

public void Clear()

ClearFormulaValues()

Removes all values of cells with formulas, but keeps the formulas.

public void ClearFormulaValues()

ClearFormulas()

Removes all formulas within the range, but keeps the calculated values.

public void ClearFormulas()

Copy(ExcelRangeBase)

Copies the range of cells to another range.

public void Copy(ExcelRangeBase Destination)

Parameters

Destination ExcelRangeBase

The top-left cell where the range will be copied.

Copy(ExcelRangeBase, params ExcelRangeCopyOptionFlags[])

Copies the range of cells to an other range

public void Copy(ExcelRangeBase Destination, params ExcelRangeCopyOptionFlags[] excelRangeCopyOptionFlags)

Parameters

Destination ExcelRangeBase

The start cell where the range will be copied.

excelRangeCopyOptionFlags ExcelRangeCopyOptionFlags[]

Cell properties that will not be copied.

Copy(ExcelRangeBase, ExcelRangeCopyOptionFlags?)

Copies the range of cells to an other range

public void Copy(ExcelRangeBase Destination, ExcelRangeCopyOptionFlags? excelRangeCopyOptionFlags)

Parameters

Destination ExcelRangeBase

The start cell where the range will be copied.

excelRangeCopyOptionFlags ExcelRangeCopyOptionFlags?

Cell properties that will not be copied.

CopyStyles(ExcelRangeBase)

Copy the styles from the source range to the destination range. If the destination range is larger than the source range, the styles of the column to the right and the row at the bottom will be expanded to the destination.

public void CopyStyles(ExcelRangeBase Destination)

Parameters

Destination ExcelRangeBase

The destination range

CreateArrayFormula(string)

Creates an array-formula.

public void CreateArrayFormula(string ArrayFormula)

Parameters

ArrayFormula string

The formula

CreateHtmlExporter()

Creates an IExcelHtmlRangeExporter for html export of this range.

public IExcelHtmlRangeExporter CreateHtmlExporter()

Returns

IExcelHtmlRangeExporter

A html exporter

Delete(eShiftTypeDelete)

Delete the range from the worksheet and shift affected cells in the selected direction.

public void Delete(eShiftTypeDelete shift)

Parameters

shift eShiftTypeDelete

The direction that the cells will shift.

Dispose()

Disposes the object

public void Dispose()

FillDateTime()

Fills the range by adding 1 day to each cell starting from the value in the top left cell by column.

public void FillDateTime()

FillDateTime(Action<FillDateParams>)

Fill the range with dates.

public void FillDateTime(Action<FillDateParams> options)

Parameters

options Action<FillDateParams>

Options how to perform the fill

FillDateTime(DateTime?, eDateTimeUnit, int)

Fills the range by adding 1 day to each cell per column starting from startValue.

public void FillDateTime(DateTime? startValue, eDateTimeUnit dateTimeUnit = eDateTimeUnit.Day, int stepValue = 1)

Parameters

startValue DateTime?
dateTimeUnit eDateTimeUnit
stepValue int

FillList<T>(IEnumerable<T>)

Fills the range columnwise using the values in the list.

public void FillList<T>(IEnumerable<T> list)

Parameters

list IEnumerable<T>

The list to use.

Type Parameters

T

Type used in the list.

FillList<T>(IEnumerable<T>, Action<FillListParams>) 

public void FillList<T>(IEnumerable<T> list, Action<FillListParams> options)

Parameters

list IEnumerable<T>
options Action<FillListParams>

Type Parameters

T

FillNumber()

Fills the range by adding 1 to each cell starting from the value in the top left cell by column

public void FillNumber()

FillNumber(Action<FillNumberParams>)

Fills a range by using the argument options.

public void FillNumber(Action<FillNumberParams> options)

Parameters

options Action<FillNumberParams>

The option to configure the fill.

FillNumber(double?, double)

Fills a range by adding the step value to the start Value. If startValue is null the first value in the row/column is used. Fill is done by column from top to bottom

public void FillNumber(double? startValue, double stepValue = 1)

Parameters

startValue double?

The start value of the first cell. If this value is null the value of the first cell is used.

stepValue double

The value used for each step

GetCellValue<T>()

Gets the typed value of a cell

public T GetCellValue<T>()

Returns

T

The value of the cell

Type Parameters

T

The returned type

GetCellValue<T>(int)

Gets the value of a cell using an offset from the top-left cell in the range.

public T GetCellValue<T>(int columnOffset)

Parameters

columnOffset int

Column offset from the top-left cell in the range

Returns

T

Type Parameters

T

The returned type

GetCellValue<T>(int, int)

Gets the value of a cell using an offset from the top-left cell in the range.

public T GetCellValue<T>(int rowOffset, int columnOffset)

Parameters

rowOffset int

Row offset from the top-left cell in the range

columnOffset int

Column offset from the top-left cell in the range

Returns

T

Type Parameters

T

The returned type

GetEnumerator()

Gets the enumerator for the collection

public IEnumerator<ExcelRangeBase> GetEnumerator()

Returns

IEnumerator<ExcelRangeBase>

The enumerator

GetTable()

Returns the ExcelTable if the range is a table. If the range doesn't or partly matches a table range, null is returned. IsTable

public ExcelTable GetTable()

Returns

ExcelTable

GetValue<T>()

Convert cell value to desired type, including nullable structs. When converting blank string to nullable struct (e.g. ' ' to int?) null is returned. When attempted conversion fails exception is passed through.

public T GetValue<T>()

Returns

T

The Value converted to T.

Type Parameters

T

The type to convert to.

Remarks

If Value is string, parsing is performed for output types of DateTime and TimeSpan, which if fails throws FormatException. Another special case for output types of DateTime and TimeSpan is when input is double, in which case FromOADate(double) is used for conversion. This special case does not work through other types convertible to double (e.g. integer or string with number). In all other cases 'direct' conversion ChangeType(object, Type) is performed.

Exceptions

FormatException

Value is string and its format is invalid for conversion (parsing fails)

InvalidCastException

Value is not string and direct conversion fails

Insert(eShiftTypeInsert)

Insert cells into the worksheet and shift the cells to the selected direction.

public void Insert(eShiftTypeInsert shift)

Parameters

shift eShiftTypeInsert

The direction that the cells will shift.

LoadFromArrays(IEnumerable<object[]>)

Loads data from the collection of arrays of objects into the range, starting from the top-left cell.

public ExcelRangeBase LoadFromArrays(IEnumerable<object[]> Data)

Parameters

Data IEnumerable<object[]>

The data.

Returns

ExcelRangeBase

LoadFromArraysTransposed(IEnumerable<object[]>)

Loads data from the collection of arrays of objects into the range transposed, starting from the top-left cell.

public ExcelRangeBase LoadFromArraysTransposed(IEnumerable<object[]> Data)

Parameters

Data IEnumerable<object[]>

Returns

ExcelRangeBase

LoadFromCollection<T>(IEnumerable<T>)

Load a collection into a the worksheet starting from the top left row of the range.

public ExcelRangeBase LoadFromCollection<T>(IEnumerable<T> Collection)

Parameters

Collection IEnumerable<T>

The collection to load

Returns

ExcelRangeBase

The filled range

Type Parameters

T

The datatype in the collection

LoadFromCollection<T>(IEnumerable<T>, Action<LoadFromCollectionParams>)

Load a collection into the worksheet starting from the top left row of the range.

public ExcelRangeBase LoadFromCollection<T>(IEnumerable<T> collection, Action<LoadFromCollectionParams> paramsConfig)

Parameters

collection IEnumerable<T>

The collection to load

paramsConfig Action<LoadFromCollectionParams>

Action<T> to provide parameters to the function

Returns

ExcelRangeBase

The filled range

Type Parameters

T

The datatype in the collection

Examples

sheet.Cells["C1"].LoadFromCollection(items, c =>
{
    c.PrintHeaders = true;
    c.TableStyle = TableStyles.Dark1;
});

LoadFromCollection<T>(IEnumerable<T>, bool)

Load a collection of T into the worksheet starting from the top left row of the range. Default option will load all public instance properties of T

public ExcelRangeBase LoadFromCollection<T>(IEnumerable<T> Collection, bool PrintHeaders)

Parameters

Collection IEnumerable<T>

The collection to load

PrintHeaders bool

Print the property names on the first row. If the property is decorated with a DisplayNameAttribute or a DescriptionAttribute that attribute will be used instead of the reflected member name.

Returns

ExcelRangeBase

The filled range

Type Parameters

T

The datatype in the collection

LoadFromCollection<T>(IEnumerable<T>, bool, TableStyles?)

Load a collection of T into the worksheet starting from the top left row of the range. Default option will load all public instance properties of T

public ExcelRangeBase LoadFromCollection<T>(IEnumerable<T> Collection, bool PrintHeaders, TableStyles? TableStyle)

Parameters

Collection IEnumerable<T>

The collection to load

PrintHeaders bool

Print the property names on the first row. If the property is decorated with a DisplayNameAttribute or a DescriptionAttribute that attribute will be used instead of the reflected member name.

TableStyle TableStyles?

Will create a table with this style. If set to TableStyles.None no table will be created

Returns

ExcelRangeBase

The filled range

Type Parameters

T

The datatype in the collection

LoadFromCollection<T>(IEnumerable<T>, bool, TableStyles?, bool)

Load a collection of T into the worksheet starting from the top left row of the range. Default option will load all public instance properties of T

public ExcelRangeBase LoadFromCollection<T>(IEnumerable<T> Collection, bool PrintHeaders, TableStyles? TableStyle, bool Transpose)

Parameters

Collection IEnumerable<T>

The collection to load

PrintHeaders bool

Print the property names on the first row. If the property is decorated with a DisplayNameAttribute or a DescriptionAttribute that attribute will be used instead of the reflected member name.

TableStyle TableStyles?

Will create a table with this style. If set to TableStyles.None no table will be created

Transpose bool

Will load data transposed

Returns

ExcelRangeBase

The filled range

Type Parameters

T

The datatype in the collection

LoadFromCollection<T>(IEnumerable<T>, bool, TableStyles?, bool, BindingFlags, MemberInfo[])

Load a collection into the worksheet starting from the top left row of the range.

public ExcelRangeBase LoadFromCollection<T>(IEnumerable<T> Collection, bool PrintHeaders, TableStyles? TableStyle, bool Transpose, BindingFlags memberFlags, MemberInfo[] Members)

Parameters

Collection IEnumerable<T>

The collection to load

PrintHeaders bool

Print the property names on the first row. Any underscore in the property name will be converted to a space. If the property is decorated with a DisplayNameAttribute or a DescriptionAttribute that attribute will be used instead of the reflected member name.

TableStyle TableStyles?

Will create a table with this style. If set to TableStyles.None no table will be created

Transpose bool

Will insert data transposed

memberFlags BindingFlags

Property flags to use

Members MemberInfo[]

The properties to output. Must be of type T

Returns

ExcelRangeBase

The filled range

Type Parameters

T

The datatype in the collection

LoadFromCollection<T>(IEnumerable<T>, bool, TableStyles?, BindingFlags, MemberInfo[])

Load a collection into the worksheet starting from the top left row of the range.

public ExcelRangeBase LoadFromCollection<T>(IEnumerable<T> Collection, bool PrintHeaders, TableStyles? TableStyle, BindingFlags memberFlags, MemberInfo[] Members)

Parameters

Collection IEnumerable<T>

The collection to load

PrintHeaders bool

Print the property names on the first row. Any underscore in the property name will be converted to a space. If the property is decorated with a DisplayNameAttribute or a DescriptionAttribute that attribute will be used instead of the reflected member name.

TableStyle TableStyles?

Will create a table with this style. If set to TableStyles.None no table will be created

memberFlags BindingFlags

Property flags to use

Members MemberInfo[]

The properties to output. Must be of type T

Returns

ExcelRangeBase

The filled range

Type Parameters

T

The datatype in the collection

LoadFromDataReader(IDataReader, bool)

Load the data from the datareader starting from the top left cell of the range

public ExcelRangeBase LoadFromDataReader(IDataReader Reader, bool PrintHeaders)

Parameters

Reader IDataReader

The datareader to load from

PrintHeaders bool

Print the caption property (if set) or the columnname property if not, on first row

Returns

ExcelRangeBase

The filled range

LoadFromDataReader(IDataReader, bool, bool)

Load the data from the datareader starting from the top left cell of the range

public ExcelRangeBase LoadFromDataReader(IDataReader Reader, bool PrintHeaders, bool Transpose)

Parameters

Reader IDataReader

The datareader to load from

PrintHeaders bool

Print the caption property (if set) or the columnname property if not, on first row

Transpose bool

Must be true to transpose data

Returns

ExcelRangeBase

The filled range

LoadFromDataReader(IDataReader, bool, string, TableStyles)

Load the data from the datareader starting from the top left cell of the range

public ExcelRangeBase LoadFromDataReader(IDataReader Reader, bool PrintHeaders, string TableName, TableStyles TableStyle = TableStyles.None)

Parameters

Reader IDataReader

The datareader to loadfrom

PrintHeaders bool

Print the column caption property (if set) or the columnname property if not, on first row

TableName string

The name of the table

TableStyle TableStyles

The table style to apply to the data

Returns

ExcelRangeBase

The filled range

LoadFromDataReader(IDataReader, bool, string, bool, TableStyles)

Load the data from the datareader starting from the top left cell of the range

public ExcelRangeBase LoadFromDataReader(IDataReader Reader, bool PrintHeaders, string TableName, bool Transpose, TableStyles TableStyle = TableStyles.None)

Parameters

Reader IDataReader

The datareader to loadfrom

PrintHeaders bool

Print the column caption property (if set) or the columnname property if not, on first row

TableName string

The name of the table

Transpose bool

Transpose the data

TableStyle TableStyles

The table style to apply to the data

Returns

ExcelRangeBase

The filled range

LoadFromDataReaderAsync(DbDataReader, bool)

Load the data from the datareader starting from the top left cell of the range

public Task<ExcelRangeBase> LoadFromDataReaderAsync(DbDataReader Reader, bool PrintHeaders)

Parameters

Reader DbDataReader

The datareader to load from

PrintHeaders bool

Print the caption property (if set) or the columnname property if not, on first row

Returns

Task<ExcelRangeBase>

The filled range

LoadFromDataReaderAsync(DbDataReader, bool, bool)

Load the data from the datareader starting from the top left cell of the range

public Task<ExcelRangeBase> LoadFromDataReaderAsync(DbDataReader Reader, bool PrintHeaders, bool Transpose)

Parameters

Reader DbDataReader

The datareader to load from

PrintHeaders bool

Print the caption property (if set) or the columnname property if not, on first row

Transpose bool

If the data should be transposed on read or not

Returns

Task<ExcelRangeBase>

The filled range

LoadFromDataReaderAsync(DbDataReader, bool, string, TableStyles, CancellationToken?)

Load the data from the datareader starting from the top left cell of the range

public Task<ExcelRangeBase> LoadFromDataReaderAsync(DbDataReader Reader, bool PrintHeaders, string TableName, TableStyles TableStyle = TableStyles.None, CancellationToken? cancellationToken = null)

Parameters

Reader DbDataReader

The datareader to loadfrom

PrintHeaders bool

Print the column caption property (if set) or the columnname property if not, on first row

TableName string

The name of the table

TableStyle TableStyles

The table style to apply to the data

cancellationToken CancellationToken?

The cancellation token to use

Returns

Task<ExcelRangeBase>

The filled range

LoadFromDataReaderAsync(DbDataReader, bool, string, bool, TableStyles, CancellationToken?)

Load the data from the datareader starting from the top left cell of the range

public Task<ExcelRangeBase> LoadFromDataReaderAsync(DbDataReader Reader, bool PrintHeaders, string TableName, bool Transpose, TableStyles TableStyle = TableStyles.None, CancellationToken? cancellationToken = null)

Parameters

Reader DbDataReader

The datareader to loadfrom

PrintHeaders bool

Print the column caption property (if set) or the columnname property if not, on first row

TableName string

The name of the table

Transpose bool
TableStyle TableStyles

The table style to apply to the data

cancellationToken CancellationToken?

The cancellation token to use

Returns

Task<ExcelRangeBase>

The filled range

LoadFromDataReaderAsync(DbDataReader, bool, CancellationToken)

Load the data from the datareader starting from the top left cell of the range

public Task<ExcelRangeBase> LoadFromDataReaderAsync(DbDataReader Reader, bool PrintHeaders, CancellationToken cancellationToken)

Parameters

Reader DbDataReader

The datareader to load from

PrintHeaders bool

Print the caption property (if set) or the columnname property if not, on first row

cancellationToken CancellationToken

The cancellation token to use

Returns

Task<ExcelRangeBase>

The filled range

LoadFromDataReaderAsync(DbDataReader, bool, CancellationToken, bool)

Load the data from the datareader starting from the top left cell of the range

public Task<ExcelRangeBase> LoadFromDataReaderAsync(DbDataReader Reader, bool PrintHeaders, CancellationToken cancellationToken, bool Transpose)

Parameters

Reader DbDataReader

The datareader to load from

PrintHeaders bool

Print the caption property (if set) or the columnname property if not, on first row

cancellationToken CancellationToken

The cancellation token to use

Transpose bool

Returns

Task<ExcelRangeBase>

The filled range

LoadFromDataTable(DataTable)

Load the data from the datatable starting from the top left cell of the range

public ExcelRangeBase LoadFromDataTable(DataTable table)

Parameters

table DataTable

The datatable to load

Returns

ExcelRangeBase

The filled range

LoadFromDataTable(DataTable, Action<LoadFromDataTableParams>)

Load the data from the DataTable starting from the top left cell of the range

public ExcelRangeBase LoadFromDataTable(DataTable table, Action<LoadFromDataTableParams> paramsConfig)

Parameters

table DataTable
paramsConfig Action<LoadFromDataTableParams>

Action<T> to provide parameters to the function

Returns

ExcelRangeBase

The filled range

Examples

sheet.Cells["C1"].LoadFromDataTable(dataTable, c =>
{
    c.PrintHeaders = true;
    c.TableStyle = TableStyles.Dark1;
});

LoadFromDataTable(DataTable, bool)

Load the data from the datatable starting from the top left cell of the range

public ExcelRangeBase LoadFromDataTable(DataTable Table, bool PrintHeaders)

Parameters

Table DataTable

The datatable to load

PrintHeaders bool

Print the caption property (if set) or the columnname property if not, on first row

Returns

ExcelRangeBase

The filled range

LoadFromDataTable(DataTable, bool, TableStyles?)

Load the data from the datatable starting from the top left cell of the range

public ExcelRangeBase LoadFromDataTable(DataTable Table, bool PrintHeaders, TableStyles? TableStyle)

Parameters

Table DataTable

The datatable to load

PrintHeaders bool

Print the column caption property (if set) or the columnname property if not, on first row

TableStyle TableStyles?

The table style to apply to the data

Returns

ExcelRangeBase

The filled range

LoadFromDataTable(DataTable, bool, TableStyles?, bool)

Load the data from the datatable starting from the top left cell of the range

public ExcelRangeBase LoadFromDataTable(DataTable Table, bool PrintHeaders, TableStyles? TableStyle, bool Transpose)

Parameters

Table DataTable

The datatable to load

PrintHeaders bool

Print the column caption property (if set) or the columnname property if not, on first row

TableStyle TableStyles?

The table style to apply to the data

Transpose bool

Transpose the loaded data

Returns

ExcelRangeBase

The filled range

LoadFromDictionaries(IEnumerable<IDictionary<string, object>>)

Load a collection of dictionaries (or dynamic/ExpandoObjects) into the worksheet starting from the top left row of the range. These dictionaries should have the same set of keys.

public ExcelRangeBase LoadFromDictionaries(IEnumerable<IDictionary<string, object>> items)

Parameters

items IEnumerable<IDictionary<string, object>>

A list of dictionaries/>

Returns

ExcelRangeBase

The filled range

Examples

var items = new List<IDictionary<string, object>>()
  {
      new Dictionary<string, object>()
      { 
          { "Id", 1 },
          { "Name", "TestName 1" }
      },
      new Dictionary<string, object>()
      {
          { "Id", 2 },
          { "Name", "TestName 2" }
      }
  };
  using(var package = new ExcelPackage())
  {
      var sheet = package.Workbook.Worksheets.Add("test");
      var r = sheet.Cells["A1"].LoadFromDictionaries(items);
  }

LoadFromDictionaries(IEnumerable<IDictionary<string, object>>, Action<LoadFromDictionariesParams>)

Load a collection of dictionaries (or dynamic/ExpandoObjects) into the worksheet starting from the top left row of the range. These dictionaries should have the same set of keys.

public ExcelRangeBase LoadFromDictionaries(IEnumerable<IDictionary<string, object>> items, Action<LoadFromDictionariesParams> paramsConfig)

Parameters

items IEnumerable<IDictionary<string, object>>

A list of dictionaries/ExpandoObjects

paramsConfig Action<LoadFromDictionariesParams>

Action<T> to provide parameters to the function

Returns

ExcelRangeBase

Examples

sheet.Cells["C1"].LoadFromDictionaries(items, c => { c.PrintHeaders = true; c.TableStyle = TableStyles.Dark1; });

LoadFromDictionaries(IEnumerable<IDictionary<string, object>>, bool)

Load a collection of dictionaries (or dynamic/ExpandoObjects) into the worksheet starting from the top left row of the range. These dictionaries should have the same set of keys.

public ExcelRangeBase LoadFromDictionaries(IEnumerable<IDictionary<string, object>> items, bool printHeaders)

Parameters

items IEnumerable<IDictionary<string, object>>

A list of dictionaries/>

printHeaders bool

If true the key names from the first instance will be used as headers

Returns

ExcelRangeBase

The filled range

Examples

var items = new List<IDictionary<string, object>>()
  {
      new Dictionary<string, object>()
      { 
          { "Id", 1 },
          { "Name", "TestName 1" }
      },
      new Dictionary<string, object>()
      {
          { "Id", 2 },
          { "Name", "TestName 2" }
      }
  };
  using(var package = new ExcelPackage())
  {
      var sheet = package.Workbook.Worksheets.Add("test");
      var r = sheet.Cells["A1"].LoadFromDictionaries(items, true);
  }

LoadFromDictionaries(IEnumerable<IDictionary<string, object>>, bool, TableStyles?)

Load a collection of dictionaries (or dynamic/ExpandoObjects) into the worksheet starting from the top left row of the range. These dictionaries should have the same set of keys.

public ExcelRangeBase LoadFromDictionaries(IEnumerable<IDictionary<string, object>> items, bool printHeaders, TableStyles? tableStyle)

Parameters

items IEnumerable<IDictionary<string, object>>

A list of dictionaries/>

printHeaders bool

If true the key names from the first instance will be used as headers

tableStyle TableStyles?

Will create a table with this style. If set to TableStyles.None no table will be created

Returns

ExcelRangeBase

The filled range

Examples

var items = new List<IDictionary<string, object>>()
  {
      new Dictionary<string, object>()
      { 
          { "Id", 1 },
          { "Name", "TestName 1" }
      },
      new Dictionary<string, object>()
      {
          { "Id", 2 },
          { "Name", "TestName 2" }
      }
  };
  using(var package = new ExcelPackage())
  {
      var sheet = package.Workbook.Worksheets.Add("test");
      var r = sheet.Cells["A1"].LoadFromDictionaries(items, true, TableStyles.None);
  }

LoadFromDictionaries(IEnumerable<IDictionary<string, object>>, bool, TableStyles?, IEnumerable<string>)

Load a collection of dictionaries (or dynamic/ExpandoObjects) into the worksheet starting from the top left row of the range. These dictionaries should have the same set of keys.

public ExcelRangeBase LoadFromDictionaries(IEnumerable<IDictionary<string, object>> items, bool printHeaders, TableStyles? tableStyle, IEnumerable<string> keys)

Parameters

items IEnumerable<IDictionary<string, object>>

A list of dictionaries

printHeaders bool

If true the key names from the first instance will be used as headers

tableStyle TableStyles?

Will create a table with this style. If set to TableStyles.None no table will be created

keys IEnumerable<string>

Keys that should be used, keys omitted will not be included

Returns

ExcelRangeBase

The filled range

Examples

var items = new List<IDictionary<string, object>>()
  {
      new Dictionary<string, object>()
      { 
          { "Id", 1 },
          { "Name", "TestName 1" }
      },
      new Dictionary<string, object>()
      {
          { "Id", 2 },
          { "Name", "TestName 2" }
      }
  };
  using(var package = new ExcelPackage())
  {
      var sheet = package.Workbook.Worksheets.Add("test");
      var r = sheet.Cells["A1"].LoadFromDictionaries(items, true, TableStyles.None, null);
  }

LoadFromDictionaries(IEnumerable<dynamic>, Action<LoadFromDictionariesParams>)

Load a collection of dictionaries (or dynamic/ExpandoObjects) into the worksheet starting from the top left row of the range. These dictionaries should have the same set of keys.

public ExcelRangeBase LoadFromDictionaries(IEnumerable<dynamic> items, Action<LoadFromDictionariesParams> paramsConfig)

Parameters

items IEnumerable<dynamic>

A list of dictionaries/ExpandoObjects

paramsConfig Action<LoadFromDictionariesParams>

Action<T> to provide parameters to the function

Returns

ExcelRangeBase

Examples

sheet.Cells["C1"].LoadFromDictionaries(items, c => { c.PrintHeaders = true; c.TableStyle = TableStyles.Dark1; });

LoadFromDictionaries(IEnumerable<dynamic>, bool, TableStyles?, IEnumerable<string>)

Load a collection of dictionaries (or dynamic/ExpandoObjects) into the worksheet starting from the top left row of the range. These dictionaries should have the same set of keys.

public ExcelRangeBase LoadFromDictionaries(IEnumerable<dynamic> items, bool printHeaders, TableStyles? tableStyle, IEnumerable<string> keys)

Parameters

items IEnumerable<dynamic>

A list of dictionaries

printHeaders bool

If true the key names from the first instance will be used as headers

tableStyle TableStyles?

Will create a table with this style. If set to TableStyles.None no table will be created

keys IEnumerable<string>

Keys that should be used, keys omitted will not be included

Returns

ExcelRangeBase

The filled range

Examples

var items = new List<IDictionary<string, object>>()
  {
      new Dictionary<string, object>()
      { 
          { "Id", 1 },
          { "Name", "TestName 1" }
      },
      new Dictionary<string, object>()
      {
          { "Id", 2 },
          { "Name", "TestName 2" }
      }
  };
  using(var package = new ExcelPackage())
  {
      var sheet = package.Workbook.Worksheets.Add("test");
      var r = sheet.Cells["A1"].LoadFromDictionaries(items, true, TableStyles.None, null);
  }

LoadFromText(FileInfo)

Loads a CSV file into a range starting from the top left cell using ASCII Encoding.

public ExcelRangeBase LoadFromText(FileInfo TextFile)

Parameters

TextFile FileInfo

The Textfile

Returns

ExcelRangeBase

LoadFromText(FileInfo, ExcelTextFormat)

Loads a CSV file into a range starting from the top left cell.

public ExcelRangeBase LoadFromText(FileInfo TextFile, ExcelTextFormat Format)

Parameters

TextFile FileInfo

The Textfile

Format ExcelTextFormat

Information how to load the text

Returns

ExcelRangeBase

LoadFromText(FileInfo, ExcelTextFormat, TableStyles?, bool)

Loads a CSV file into a range starting from the top left cell.

public ExcelRangeBase LoadFromText(FileInfo TextFile, ExcelTextFormat Format, TableStyles? TableStyle, bool FirstRowIsHeader)

Parameters

TextFile FileInfo

The Textfile

Format ExcelTextFormat

Information how to load the text

TableStyle TableStyles?

Create a table with this style

FirstRowIsHeader bool

Use the first row as header

Returns

ExcelRangeBase

LoadFromText(FileInfo, ExcelTextFormatFixedWidth)

Loads a fixed width text file into range starting from the top left cell.

public ExcelRangeBase LoadFromText(FileInfo TextFile, ExcelTextFormatFixedWidth Format)

Parameters

TextFile FileInfo

The Textfile

Format ExcelTextFormatFixedWidth

Information how to load the text

Returns

ExcelRangeBase

LoadFromText(string)

Loads a CSV text into a range starting from the top left cell. Default settings is Comma separation

public ExcelRangeBase LoadFromText(string Text)

Parameters

Text string

The Text

Returns

ExcelRangeBase

The range containing the data

LoadFromText(string, ExcelTextFormat)

Loads a CSV text into a range starting from the top left cell.

public ExcelRangeBase LoadFromText(string Text, ExcelTextFormat Format)

Parameters

Text string

The Text

Format ExcelTextFormat

Information how to load the text

Returns

ExcelRangeBase

The range containing the data

LoadFromText(string, ExcelTextFormat, TableStyles?, bool)

Loads a CSV text into a range starting from the top left cell.

public ExcelRangeBase LoadFromText(string Text, ExcelTextFormat Format, TableStyles? TableStyle, bool FirstRowIsHeader)

Parameters

Text string

The Text

Format ExcelTextFormat

Information how to load the text

TableStyle TableStyles?

Create a table with this style. If this parameter is not null no table will be created.

FirstRowIsHeader bool

Use the first row as header

Returns

ExcelRangeBase

LoadFromText(string, ExcelTextFormatFixedWidth)

Loads a fixed width text file into range starting from the top left cell.

public ExcelRangeBase LoadFromText(string Text, ExcelTextFormatFixedWidth Format)

Parameters

Text string

The Text file

Format ExcelTextFormatFixedWidth

Information how to load the text

Returns

ExcelRangeBase

LoadFromTextAsync(FileInfo)

Loads a CSV file into a range starting from the top left cell.

public Task<ExcelRangeBase> LoadFromTextAsync(FileInfo TextFile)

Parameters

TextFile FileInfo

The Textfile

Returns

Task<ExcelRangeBase>

LoadFromTextAsync(FileInfo, ExcelTextFormat)

Loads a CSV file into a range starting from the top left cell.

public Task<ExcelRangeBase> LoadFromTextAsync(FileInfo TextFile, ExcelTextFormat Format)

Parameters

TextFile FileInfo

The Textfile

Format ExcelTextFormat

Information how to load the text

Returns

Task<ExcelRangeBase>

LoadFromTextAsync(FileInfo, ExcelTextFormat, TableStyles, bool)

Loads a CSV file into a range starting from the top left cell.

public Task<ExcelRangeBase> LoadFromTextAsync(FileInfo TextFile, ExcelTextFormat Format, TableStyles TableStyle, bool FirstRowIsHeader)

Parameters

TextFile FileInfo

The Textfile

Format ExcelTextFormat

Information how to load the text

TableStyle TableStyles

Create a table with this style

FirstRowIsHeader bool

Use the first row as header

Returns

Task<ExcelRangeBase>

MoveNext()

Iterate to the next cell

public bool MoveNext()

Returns

bool

False if no more cells exists

Offset(int, int)

Get a range with an offset from the top left cell. The new range has the same dimensions as the current range

public ExcelRangeBase Offset(int RowOffset, int ColumnOffset)

Parameters

RowOffset int

Row Offset

ColumnOffset int

Column Offset

Returns

ExcelRangeBase

Offset(int, int, int, int)

Get a range with an offset from the top left cell.

public ExcelRangeBase Offset(int RowOffset, int ColumnOffset, int NumberOfRows, int NumberOfColumns)

Parameters

RowOffset int

Row Offset

ColumnOffset int

Column Offset

NumberOfRows int

Number of rows. Minimum 1

NumberOfColumns int

Number of colums. Minimum 1

Returns

ExcelRangeBase

Reset()

Reset the enumerator

public void Reset()

SaveToJson(Stream)

Saves the range as JSON to a stream.

public void SaveToJson(Stream stream)

Parameters

stream Stream

The writable stream to write the JSON to.

SaveToJson(Stream, Action<JsonRangeExportSettings>)

Saves the range as JSON to a stream.

public void SaveToJson(Stream stream, Action<JsonRangeExportSettings> settings)

Parameters

stream Stream

The writable stream to write the JSON to

settings Action<JsonRangeExportSettings>

Configures settings for the JSON export

SaveToJsonAsync(Stream)

Save the range to json

public Task SaveToJsonAsync(Stream stream)

Parameters

stream Stream

The stream to save to.

Returns

Task

SaveToJsonAsync(Stream, Action<JsonRangeExportSettings>)

Save the range to json

public Task SaveToJsonAsync(Stream stream, Action<JsonRangeExportSettings> settings)

Parameters

stream Stream

The stream to save to.

settings Action<JsonRangeExportSettings>

Settings for the json output.

Returns

Task

SaveToText(FileInfo, ExcelOutputTextFormat)

Converts a range to text in CSV format. Invariant culture is used by default.

public void SaveToText(FileInfo file, ExcelOutputTextFormat Format)

Parameters

file FileInfo

The file to write to

Format ExcelOutputTextFormat

Information how to create the csv text

SaveToText(FileInfo, ExcelOutputTextFormatFixedWidth)

Converts a range to text in fixed widths format. Invariant culture is used by default.

public void SaveToText(FileInfo file, ExcelOutputTextFormatFixedWidth Format)

Parameters

file FileInfo

The file to write to

Format ExcelOutputTextFormatFixedWidth

Information how to create the fixed width text

SaveToText(Stream, ExcelOutputTextFormat)

Converts a range to text in CSV format. Invariant culture is used by default.

public void SaveToText(Stream stream, ExcelOutputTextFormat Format)

Parameters

stream Stream

The strem to write to

Format ExcelOutputTextFormat

Information how to create the csv text

SaveToText(Stream, ExcelOutputTextFormatFixedWidth)

Converts a range to text in Fixed Width format. Invariant culture is used by default.

public void SaveToText(Stream stream, ExcelOutputTextFormatFixedWidth Format)

Parameters

stream Stream

The strem to write to

Format ExcelOutputTextFormatFixedWidth

Information how to create the fixed width text

SaveToTextAsync(FileInfo, ExcelOutputTextFormat)

Converts a range to text in CSV format. Invariant culture is used by default.

public Task SaveToTextAsync(FileInfo file, ExcelOutputTextFormat Format)

Parameters

file FileInfo

The file to write to

Format ExcelOutputTextFormat

Information how to create the csv text

Returns

Task

SaveToTextAsync(FileInfo, ExcelOutputTextFormatFixedWidth)

Converts a range to text in fixed widths format. Invariant culture is used by default.

public Task SaveToTextAsync(FileInfo file, ExcelOutputTextFormatFixedWidth Format)

Parameters

file FileInfo

The file to write to

Format ExcelOutputTextFormatFixedWidth

Information how to create the fixed width text

Returns

Task

SaveToTextAsync(Stream, ExcelOutputTextFormat)

Converts a range to text in CSV format. Invariant culture is used by default.

public Task SaveToTextAsync(Stream stream, ExcelOutputTextFormat Format)

Parameters

stream Stream

The strem to write to

Format ExcelOutputTextFormat

Information how to create the csv text

Returns

Task

SaveToTextAsync(Stream, ExcelOutputTextFormatFixedWidth)

Converts a range to text in Fixed Width format. Invariant culture is used by default.

public Task SaveToTextAsync(Stream stream, ExcelOutputTextFormatFixedWidth Format)

Parameters

stream Stream

The strem to write to

Format ExcelOutputTextFormatFixedWidth

Information how to create the fixed width text

Returns

Task

SetCellValue(int, int, object)

Sets the value of a cell using an offset from the top-left cell in the range.

public void SetCellValue(int rowOffset, int columnOffset, object value)

Parameters

rowOffset int

Row offset from the top-left cell in the range

columnOffset int

Column offset from the top-left cell in the range

value object

The value to set.

SetErrorValue(eErrorType)

Sets the range to an Error value

public void SetErrorValue(eErrorType errorType)

Parameters

errorType eErrorType

The type of error

SetHyperlink(ExcelHyperLink)

Sets the Hyperlink property using the ExcelHyperLink class.

public void SetHyperlink(ExcelHyperLink uri)

Parameters

uri ExcelHyperLink

The ExcelHyperLink uri to set

SetHyperlink(ExcelRange)

Sets the Hyperlink property to an url within the workbook. The hyperlink will display the value of the cell.

public void SetHyperlink(ExcelRange range)

Parameters

range ExcelRange

A reference within the same workbook

SetHyperlink(ExcelRange, string)

Sets the Hyperlink property to an url within the workbook.

public void SetHyperlink(ExcelRange range, string display)

Parameters

range ExcelRange

A reference within the same workbook

display string

The displayed text in the cell. If display is null or empty, the address of the range will be set.

SetHyperlink(Uri)

Sets the hyperlink property

public void SetHyperlink(Uri uri)

Parameters

uri Uri

The URI to set

Sort()

Sort the range by value of the first column, Ascending.

public void Sort()

Sort(RangeSortOptions)

Sort the range by value. Use RangeSortOptions.Create() to create an instance of the sort options, then use the SortBy or SortLeftToRightBy properties to build up your sort parameters.

public void Sort(RangeSortOptions options)

Parameters

options RangeSortOptions

Options for the sort

Examples

var options = RangeSortOptions.Create();
var builder = options.SortBy.Column(0);
builder.ThenSortBy.Column(2).UsingCustomList("S", "M", "L", "XL");
builder.ThenSortBy.Column(3);
worksheet.Cells["A1:D15"].Sort(options);

Sort(Action<RangeSortOptions>)

Sort the range by value. Supports top-down and left to right sort.

public void Sort(Action<RangeSortOptions> configuration)

Parameters

configuration Action<RangeSortOptions>

An action of RangeSortOptions where sort parameters can be set.

Examples

// 1. Sort rows (top-down)

// The Column function takes the zero based column index in the range
worksheet.Cells["A1:D15"].Sort(x => x.SortBy.Column(0).ThenSortBy.Column(1, eSortOrder.Descending));

// 2. Sort columns(left to right)
// The Row function takes the zero based row index in the range
worksheet.Cells["A1:D15"].Sort(x => x.SortLeftToRightBy.Row(0));

// 3. Sort using a custom list
worksheet.Cells["A1:D15"].Sort(x => x.SortBy.Column(0).UsingCustomList("S", "M", "L", "XL"));
worksheet.Cells["A1:D15"].Sort(x => x.SortLeftToRightBy.Row(0).UsingCustomList("S", "M", "L", "XL"));

Sort(int, bool)

Sort the range by value of the supplied column, Ascending.

The column to sort by within the range. Zerobased Descending if true, otherwise Ascending. Default Ascending. Zerobased 
public void Sort(int column, bool descending = false)

Parameters

column int
descending bool

Sort(int[], bool[], CultureInfo, CompareOptions)

Sort the range by value

public void Sort(int[] columns, bool[] descending = null, CultureInfo culture = null, CompareOptions compareOptions = CompareOptions.None)

Parameters

columns int[]

The column(s) to sort by within the range. Zerobased

descending bool[]

Descending if true, otherwise Ascending. Default Ascending. Zerobased

culture CultureInfo

The CultureInfo used to compare values. A null value means CurrentCulture

compareOptions CompareOptions

String compare option

ToCollectionWithMappings<T>(Func<ToCollectionRow, T>)

Returns a collection of T for the range. If the range contains multiple addresses the first range is used. The first row must containt the unique headers used as keys in the row dictionary.

public List<T> ToCollectionWithMappings<T>(Func<ToCollectionRow, T> setRow)

Parameters

setRow Func<ToCollectionRow, T>

The call back function to map each row to the item of type T.

Returns

List<T>

A list of T

Type Parameters

T

The type to map to

ToCollectionWithMappings<T>(Func<ToCollectionRow, T>, ToCollectionRangeOptions)

Returns a collection of T for the range. If the range contains multiple addresses the first range is used. The first row must containt the unique headers used as keys in the row dictionary.

public List<T> ToCollectionWithMappings<T>(Func<ToCollectionRow, T> setRow, ToCollectionRangeOptions options)

Parameters

setRow Func<ToCollectionRow, T>

The call back function to map each row to the item of type T.

options ToCollectionRangeOptions

Parameters to the function

Returns

List<T>

A list of T

Type Parameters

T

The type to map to

ToCollectionWithMappings<T>(Func<ToCollectionRow, T>, Action<ToCollectionRangeOptions>)

Returns a collection of T for the range. If the range contains multiple addresses the first range is used. The first row must contain the unique headers used as keys in the row dictionary.

public List<T> ToCollectionWithMappings<T>(Func<ToCollectionRow, T> setRow, Action<ToCollectionRangeOptions> options)

Parameters

setRow Func<ToCollectionRow, T>

The call back function to map each row to the item of type T.

options Action<ToCollectionRangeOptions>

Configures the settings for the function

Returns

List<T>

A list of T

Type Parameters

T

The type to map to

ToCollection<T>()

Returns a collection of T for the range. If the range contains multiple addresses the first range is used. The first row must contain the unique headers used as keys in the row dictionary. Headers will be mapped to properties using the name or the attributes without white spaces. The attributes that can be used are: EpplusTableColumnAttributeBase.Header, DescriptionAttribute.Description or DisplayNameAttribute.Name.

public List<T> ToCollection<T>()

Returns

List<T>

A list of T

Type Parameters

T

The type to map to

ToCollection<T>(ToCollectionRangeOptions)

Automatically maps the range to the properties T using the headers. Using this method requires a headers. Headers will be mapped to properties using the name or the attributes without white spaces. The attributes that can be used are: EpplusTableColumnAttributeBase.Header, DescriptionAttribute.Description or DisplayNameAttribute.Name.

public List<T> ToCollection<T>(ToCollectionRangeOptions options)

Parameters

options ToCollectionRangeOptions

Settings for the method

Returns

List<T>

A list of T

Type Parameters

T

The type to use

ToCollection<T>(Action<ToCollectionRangeOptions>)

Automatically maps the range to the properties T using the headers. Using this method requires a headers. Headers will be mapped to properties using the name or the attributes without white spaces. The attributes that can be used are: EpplusTableColumnAttributeBase.Header, DescriptionAttribute.Description or DisplayNameAttribute.Name.

public List<T> ToCollection<T>(Action<ToCollectionRangeOptions> options)

Parameters

options Action<ToCollectionRangeOptions>

Configures the settings for the function

Returns

List<T>

A list of T

Type Parameters

T

The type to use

ToDataTable()

Returns the range as a DataTable with the OfficeOpenXml.Export.ToDataTable.ToDataTableOptions.Default settings.

public DataTable ToDataTable()

Returns

DataTable

A DataTable representing the range.

ToDataTable(ToDataTableOptions)

Returns the range as a DataTable with the option supplied.

public DataTable ToDataTable(ToDataTableOptions options)

Parameters

options ToDataTableOptions

Sets the settings used to convert the range.

Returns

DataTable

A DataTable representing the range.

ToDataTable(ToDataTableOptions, DataTable)

Returns the range as a DataTable with the option supplied.

public DataTable ToDataTable(ToDataTableOptions options, DataTable dataTable)

Parameters

options ToDataTableOptions

Sets the settings used to convert the range.

dataTable DataTable

The data table to add the range data to.

Returns

DataTable

A DataTable representing the range.

ToDataTable(Action<ToDataTableOptions>)

Returns the range as a DataTable with the option supplied.

public DataTable ToDataTable(Action<ToDataTableOptions> configHandler)

Parameters

configHandler Action<ToDataTableOptions>

Configures the settings used to convert the range.

Returns

DataTable

A DataTable representing the range.

ToDataTable(Action<ToDataTableOptions>, DataTable)

Returns the range as a DataTable with the option supplied.

public DataTable ToDataTable(Action<ToDataTableOptions> configHandler, DataTable dataTable)

Parameters

configHandler Action<ToDataTableOptions>

Configures the settings used to convert the range.

dataTable DataTable

The data table to add the range data to.

Returns

DataTable

A DataTable representing the range.

ToDataTable(DataTable)

Returns the range as a DataTable with the option supplied.

public DataTable ToDataTable(DataTable dataTable)

Parameters

dataTable DataTable

The data table to add the range data to.

Returns

DataTable

A DataTable representing the range.

ToJson()

Returns the range as JSON

public string ToJson()

Returns

string

A JSON string

ToJson(Action<JsonRangeExportSettings>)

Returns the range as JSON

public string ToJson(Action<JsonRangeExportSettings> settings)

Parameters

settings Action<JsonRangeExportSettings>

Configures settings for the JSON export

Returns

string

ToText()

Converts a range to text in CSV format.

public string ToText()

Returns

string

A string containing the text

ToText(ExcelOutputTextFormat)

Converts a range to text in CSV format. Invariant culture is used by default.

public string ToText(ExcelOutputTextFormat Format)

Parameters

Format ExcelOutputTextFormat

Information how to create the csv text

Returns

string

A string containing the text

ToText(ExcelOutputTextFormatFixedWidth)

Converts a range to text in Fixed Width format. Invariant culture is used by default.

public string ToText(ExcelOutputTextFormatFixedWidth Format)

Parameters

Format ExcelOutputTextFormatFixedWidth

Information how to create the Fixed Width text

Returns

string

A string containing the text

ToTextAsync()

Converts a range to text in CSV format.

public Task<string> ToTextAsync()

Returns

Task<string>

A string containing the text

ToTextAsync(ExcelOutputTextFormat)

Converts a range to text in CSV format. Invariant culture is used by default.

public Task<string> ToTextAsync(ExcelOutputTextFormat Format)

Parameters

Format ExcelOutputTextFormat

Information how to create the csv text

Returns

Task<string>

A string containing the text

ToTextAsync(ExcelOutputTextFormatFixedWidth)

Converts a range to text in Fixed Width format. Invariant culture is used by default.

public Task<string> ToTextAsync(ExcelOutputTextFormatFixedWidth Format)

Parameters

Format ExcelOutputTextFormatFixedWidth

Information how to create the Fixed Width text

Returns

Task<string>

A string containing the text