Class EpplusExcelExternalRangeInfo

Provide the formula parser with information about an workbook external range.

Inheritance
System.Object
EpplusExcelExternalRangeInfo
Implements
System.Collections.Generic.IEnumerator<ICellInfo>
System.Collections.IEnumerator
System.IDisposable
System.Collections.Generic.IEnumerable<ICellInfo>
System.Collections.IEnumerable
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 class EpplusExcelExternalRangeInfo : IRangeInfo, IEnumerator<ICellInfo>, IEnumerator, IDisposable, IEnumerable<ICellInfo>, IEnumerable

Constructors

EpplusExcelExternalRangeInfo(ExcelExternalWorkbook, ExcelWorkbook, ExcelAddressBase)

The constructor

Declaration
public EpplusExcelExternalRangeInfo(ExcelExternalWorkbook externalWb, ExcelWorkbook wb, ExcelAddressBase address)
Parameters
Type Name Description
ExcelExternalWorkbook externalWb

The external workbook
ExcelWorkbook wb

The workbook having the external reference
ExcelAddressBase address

The address within the external workbook including the worksheet name

Properties

Address

The address of the range

Declaration
public ExcelAddressBase Address { get; }
Property Value
Type Description
ExcelAddressBase

Current

Return the current object in the enumeration

Declaration
public ICellInfo Current { get; }
Property Value
Type Description
ICellInfo

IsEmpty

If the range is empty, ie contains no set cells.

Declaration
public bool IsEmpty { get; }
Property Value
Type Description
System.Boolean

IsMulti

If the range contains more than one set cell.

Declaration
public bool IsMulti { get; }
Property Value
Type Description
System.Boolean

IsRef

If the range is invalid (#REF!)

Declaration
public bool IsRef { get; }
Property Value
Type Description
System.Boolean

Worksheet

Not applicable for external ranges.. Returns null

Declaration
public ExcelWorksheet Worksheet { get; }
Property Value
Type Description
ExcelWorksheet

Methods

Dispose()

Called when the object is disposed.

Declaration
public void Dispose()

GetEnumerator()

Gets the enumerator

Declaration
public IEnumerator<ICellInfo> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<ICellInfo>

The enumerator

GetNCells()

Get the number of cells in the range

Declaration
public int GetNCells()
Returns
Type Description
System.Int32

GetOffset(Int32, Int32)

Get the value from the range with the offset from the top-left cell

Declaration
public object GetOffset(int rowOffset, int colOffset)
Parameters
Type Name Description
System.Int32 rowOffset

The row offset.
System.Int32 colOffset

The column offset.
Returns
Type Description
System.Object

GetValue(Int32, Int32)

Gets the value

Declaration
public object GetValue(int row, int col)
Parameters
Type Name Description
System.Int32 row

The row
System.Int32 col

The column
Returns
Type Description
System.Object

MoveNext()

Moves to the next item in the enumeration

Declaration
public bool MoveNext()
Returns
Type Description
System.Boolean

returns true until the enumeration has reached the last cell.

NextCell()

Moves to the next item in the enumeration

Declaration
public bool NextCell()
Returns
Type Description
System.Boolean

Reset()

Resets the enumeration

Declaration
public void Reset()

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

IEnumerator.Current

Declaration
object IEnumerator.Current { get; }
Returns
Type Description
System.Object

Implements

System.Collections.Generic.IEnumerator<T>
System.Collections.IEnumerator
System.IDisposable
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable