Table of Contents

Class ExcelRangeBase

Namespace
OfficeOpenXml
Assembly
Magicodes.EPPlus.dll
public class ExcelRangeBase : ExcelAddress, IEnumerable<ExcelRangeBase>, IEnumerable, IEnumerator<ExcelRangeBase>, IDisposable, IEnumerator
Inheritance
ExcelRangeBase
Implements
Derived
Inherited Members
Extension Methods

Fields

_rtc

protected ExcelRichTextCollection _rtc

Field Value

ExcelRichTextCollection

_worksheet

protected ExcelWorksheet _worksheet

Field Value

ExcelWorksheet

Properties

AutoFilter

public bool AutoFilter { get; set; }

Property Value

bool

Comment

public ExcelComment Comment { get; }

Property Value

ExcelComment

ConditionalFormatting

public IRangeConditionalFormatting ConditionalFormatting { get; }

Property Value

IRangeConditionalFormatting

Current

public ExcelRangeBase Current { get; }

Property Value

ExcelRangeBase

DataValidation

public IRangeDataValidation DataValidation { get; }

Property Value

IRangeDataValidation

Formula

public string Formula { get; set; }

Property Value

string

FormulaR1C1

public string FormulaR1C1 { get; set; }

Property Value

string

FullAddress

public string FullAddress { get; }

Property Value

string

FullAddressAbsolute

public string FullAddressAbsolute { get; }

Property Value

string
public Uri Hyperlink { get; set; }

Property Value

Uri

IsArrayFormula

public bool IsArrayFormula { get; }

Property Value

bool

IsRichText

public bool IsRichText { get; set; }

Property Value

bool

Merge

public bool Merge { get; set; }

Property Value

bool

RichText

public ExcelRichTextCollection RichText { get; }

Property Value

ExcelRichTextCollection

Style

public ExcelStyle Style { get; }

Property Value

ExcelStyle

StyleID

public int StyleID { get; set; }

Property Value

int

StyleName

public string StyleName { get; set; }

Property Value

string

Text

public string Text { get; }

Property Value

string

Value

public object Value { get; set; }

Property Value

object

Worksheet

public ExcelWorksheet Worksheet { get; }

Property Value

ExcelWorksheet

Methods

AddComment(string, string)

public ExcelComment AddComment(string Text, string Author)

Parameters

Text string
Author string

Returns

ExcelComment

AutoFitColumns()

public void AutoFitColumns()

AutoFitColumns(double)

public void AutoFitColumns(double MinimumWidth)

Parameters

MinimumWidth double

AutoFitColumns(double, double)

public void AutoFitColumns(double MinimumWidth, double MaximumWidth)

Parameters

MinimumWidth double
MaximumWidth double

ChangeAddress()

protected override void ChangeAddress()

Clear()

public void Clear()

Copy(ExcelRangeBase)

public void Copy(ExcelRangeBase Destination)

Parameters

Destination ExcelRangeBase

Copy(ExcelRangeBase, ExcelRangeCopyOptionFlags?)

public void Copy(ExcelRangeBase Destination, ExcelRangeCopyOptionFlags? excelRangeCopyOptionFlags)

Parameters

Destination ExcelRangeBase
excelRangeCopyOptionFlags ExcelRangeCopyOptionFlags?

CreateArrayFormula(string)

public void CreateArrayFormula(string ArrayFormula)

Parameters

ArrayFormula string

Dispose()

public void Dispose()

GetEnumerator()

public IEnumerator<ExcelRangeBase> GetEnumerator()

Returns

IEnumerator<ExcelRangeBase>

GetValue<T>()

public T GetValue<T>()

Returns

T

Type Parameters

T

LoadFromArrays(IEnumerable<object[]>)

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

Parameters

Data IEnumerable<object[]>

Returns

ExcelRangeBase

LoadFromCollection<T>(IEnumerable<T>)

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

Parameters

Collection IEnumerable<T>

Returns

ExcelRangeBase

Type Parameters

T

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

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

Parameters

Collection IEnumerable<T>
PrintHeaders bool

Returns

ExcelRangeBase

Type Parameters

T

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

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

Parameters

Collection IEnumerable<T>
PrintHeaders bool
TableStyle TableStyles

Returns

ExcelRangeBase

Type Parameters

T

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

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

Parameters

Collection IEnumerable<T>
PrintHeaders bool
TableStyle TableStyles
memberFlags BindingFlags
Members MemberInfo[]

Returns

ExcelRangeBase

Type Parameters

T

LoadFromDataReader(IDataReader, bool)

public ExcelRangeBase LoadFromDataReader(IDataReader Reader, bool PrintHeaders)

Parameters

Reader IDataReader
PrintHeaders bool

Returns

ExcelRangeBase

LoadFromDataReader(IDataReader, bool, string, TableStyles)

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

Parameters

Reader IDataReader
PrintHeaders bool
TableName string
TableStyle TableStyles

Returns

ExcelRangeBase

LoadFromDataTable(DataTable, bool)

public ExcelRangeBase LoadFromDataTable(DataTable Table, bool PrintHeaders)

Parameters

Table DataTable
PrintHeaders bool

Returns

ExcelRangeBase

LoadFromDataTable(DataTable, bool, TableStyles)

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

Parameters

Table DataTable
PrintHeaders bool
TableStyle TableStyles

Returns

ExcelRangeBase

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

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

Parameters

items IEnumerable<IDictionary<string, object>>

Returns

ExcelRangeBase

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

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

Parameters

items IEnumerable<IDictionary<string, object>>
paramsConfig Action<LoadFromDictionariesParams>

Returns

ExcelRangeBase

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

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

Parameters

items IEnumerable<IDictionary<string, object>>
printHeaders bool

Returns

ExcelRangeBase

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

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

Parameters

items IEnumerable<IDictionary<string, object>>
printHeaders bool
tableStyle TableStyles

Returns

ExcelRangeBase

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

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

Parameters

items IEnumerable<IDictionary<string, object>>
printHeaders bool
tableStyle TableStyles
keys IEnumerable<string>

Returns

ExcelRangeBase

LoadFromText(FileInfo)

public ExcelRangeBase LoadFromText(FileInfo TextFile)

Parameters

TextFile FileInfo

Returns

ExcelRangeBase

LoadFromText(FileInfo, ExcelTextFormat)

public ExcelRangeBase LoadFromText(FileInfo TextFile, ExcelTextFormat Format)

Parameters

TextFile FileInfo
Format ExcelTextFormat

Returns

ExcelRangeBase

LoadFromText(FileInfo, ExcelTextFormat, TableStyles, bool)

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

Parameters

TextFile FileInfo
Format ExcelTextFormat
TableStyle TableStyles
FirstRowIsHeader bool

Returns

ExcelRangeBase

LoadFromText(string)

public ExcelRangeBase LoadFromText(string Text)

Parameters

Text string

Returns

ExcelRangeBase

LoadFromText(string, ExcelTextFormat)

public ExcelRangeBase LoadFromText(string Text, ExcelTextFormat Format)

Parameters

Text string
Format ExcelTextFormat

Returns

ExcelRangeBase

LoadFromText(string, ExcelTextFormat, TableStyles, bool)

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

Parameters

Text string
Format ExcelTextFormat
TableStyle TableStyles
FirstRowIsHeader bool

Returns

ExcelRangeBase

MoveNext()

public bool MoveNext()

Returns

bool

Offset(int, int)

public ExcelRangeBase Offset(int RowOffset, int ColumnOffset)

Parameters

RowOffset int
ColumnOffset int

Returns

ExcelRangeBase

Offset(int, int, int, int)

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

Parameters

RowOffset int
ColumnOffset int
NumberOfRows int
NumberOfColumns int

Returns

ExcelRangeBase

Reset()

public void Reset()

Sort()

public void Sort()

Sort(int, bool)

public void Sort(int column, bool descending = false)

Parameters

column int
descending bool

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

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

Parameters

columns int[]
descending bool[]
culture CultureInfo
compareOptions CompareOptions