Class EpplusExcelExternalRangeInfo

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

Inheritance

System.Object

EpplusExcelExternalRangeInfo

Implements

IRangeInfo

IAddressInfo

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

Assembly: EPPlus.dll

Syntax

public class EpplusExcelExternalRangeInfo : IRangeInfo, IAddressInfo, IEnumerator<ICellInfo>, IEnumerator, IDisposable, IEnumerable<ICellInfo>, IEnumerable

Constructors

EpplusExcelExternalRangeInfo(ExcelExternalWorkbook, FormulaRangeAddress, ParsingContext)

Constructor with external workbook

Declaration

public EpplusExcelExternalRangeInfo(ExcelExternalWorkbook externalWb, FormulaRangeAddress address, ParsingContext ctx)

Parameters

Type	Name	Description
ExcelExternalWorkbook	externalWb
FormulaRangeAddress	address
ParsingContext	ctx

EpplusExcelExternalRangeInfo(Int32, Int32, Int32, Int32, Int32, Int32, ParsingContext)

The constructor

Declaration

public EpplusExcelExternalRangeInfo(int externalReferenceIx, int worksheetIx, int fromRow, int fromCol, int toRow, int toCol, ParsingContext ctx)

Parameters

Type	Name	Description
System.Int32	externalReferenceIx	Index of the external workbook
System.Int32	worksheetIx	The external worksheet index/id
System.Int32	fromRow	The from row of the address
System.Int32	fromCol	The from column of the address
System.Int32	toRow	The to row of the address
System.Int32	toCol	The to column of the address
ParsingContext	ctx	Parsing context

Properties

Address

The address of the range

Declaration

public FormulaRangeAddress Address { get; }

Property Value

Type	Description
FormulaRangeAddress

Addresses

If the address contains multiple comma separated addresses, the individual addresses are stored here.

Declaration

public FormulaRangeAddress[] Addresses { get; }

Property Value

Type	Description
FormulaRangeAddress[]

Current

Return the current object in the enumeration

Declaration

public ICellInfo Current { get; }

Property Value

Type	Description
ICellInfo

Dimension

Dimension

Declaration

public FormulaRangeAddress Dimension { get; }

Property Value

Type	Description
FormulaRangeAddress

IsEmpty

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

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean

IsInMemoryRange

True if this is a range that doesn't is connected to a worksheet.

Declaration

public bool IsInMemoryRange { 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

Size

Size of the range

Declaration

public RangeDefinition Size { get; }

Property Value

Type	Description
RangeDefinition

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

GetOffset(Int32, Int32, Int32, Int32)

Get offset

Declaration

public IRangeInfo GetOffset(int rowOffsetStart, int colOffsetStart, int rowOffsetEnd, int colOffsetEnd)

Parameters

Type	Name	Description
System.Int32	rowOffsetStart
System.Int32	colOffsetStart
System.Int32	rowOffsetEnd
System.Int32	colOffsetEnd

Returns

Type	Description
IRangeInfo

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

IsHidden(Int32, Int32)

Is hidden

Declaration

public bool IsHidden(int rowOffset, int colOffset)

Parameters

Type	Name	Description
System.Int32	rowOffset
System.Int32	colOffset

Returns

Type	Description
System.Boolean

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

IRangeInfo

IAddressInfo

System.Collections.Generic.IEnumerator<T>

System.Collections.IEnumerator

System.IDisposable

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable