Class EpplusExcelExternalRangeInfo
Provide the formula parser with information about an workbook external range.
Implements
Inherited Members
Namespace: OfficeOpenXml.FormulaParsing.Ranges
Assembly: EPPlus.dll
Syntax
public class EpplusExcelExternalRangeInfo : IRangeInfo, IAddressInfo, IEnumerator<ICellInfo>, IEnumerator, IDisposable, IEnumerable<ICellInfo>, IEnumerableConstructors
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(int, int, int, int, int, int, ParsingContext)
The constructor
Declaration
public EpplusExcelExternalRangeInfo(int externalReferenceIx, int worksheetIx, int fromRow, int fromCol, int toRow, int toCol, ParsingContext ctx)Parameters
| Type | Name | Description |
|---|---|---|
| int | externalReferenceIx | Index of the external workbook |
| int | worksheetIx | The external worksheet index/id |
| int | fromRow | The from row of the address |
| int | fromCol | The from column of the address |
| int | toRow | The to row of the address |
| int | 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 |
|---|---|
| bool |
IsInMemoryRange
True if this is a range that doesn't is connected to a worksheet.
Declaration
public bool IsInMemoryRange { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsMulti
If the range contains more than one set cell.
Declaration
public bool IsMulti { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsRef
If the range is invalid (#REF!)
Declaration
public bool IsRef { get; }Property Value
| Type | Description |
|---|---|
| bool |
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()GetAddressDimensionAdjusted(int)
Get the address adjusted within the dimension of the worksheet.
Declaration
public FormulaRangeAddress GetAddressDimensionAdjusted(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The address index. |
Returns
| Type | Description |
|---|---|
| FormulaRangeAddress | The adjusted address. |
GetEnumerator()
Gets the enumerator
Declaration
public IEnumerator<ICellInfo> GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator<ICellInfo> | The enumerator |
GetNCells()
Get the number of cells in the range
Declaration
public int GetNCells()Returns
| Type | Description |
|---|---|
| int |
GetOffset(int, int)
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 |
|---|---|---|
| int | rowOffset | The row offset. |
| int | colOffset | The column offset. |
Returns
| Type | Description |
|---|---|
| object |
GetOffset(int, int, int, int)
Get offset
Declaration
public IRangeInfo GetOffset(int rowOffsetStart, int colOffsetStart, int rowOffsetEnd, int colOffsetEnd)Parameters
| Type | Name | Description |
|---|---|---|
| int | rowOffsetStart | |
| int | colOffsetStart | |
| int | rowOffsetEnd | |
| int | colOffsetEnd |
Returns
| Type | Description |
|---|---|
| IRangeInfo |
GetRangeInfoByValue()
Gets the IRangeInfo for the range for the first and last value in the range (top-left to bottom-right)
Declaration
public IRangeInfo GetRangeInfoByValue()Returns
| Type | Description |
|---|---|
| IRangeInfo | The range |
GetValue(int, int)
Gets the value
Declaration
public object GetValue(int row, int col)Parameters
| Type | Name | Description |
|---|---|---|
| int | row | The row |
| int | col | The column |
Returns
| Type | Description |
|---|---|
| object |
IsHidden(int, int)
Is hidden
Declaration
public bool IsHidden(int rowOffset, int colOffset)Parameters
| Type | Name | Description |
|---|---|---|
| int | rowOffset | |
| int | colOffset |
Returns
| Type | Description |
|---|---|
| bool |
MoveNext()
Moves to the next item in the enumeration
Declaration
public bool MoveNext()Returns
| Type | Description |
|---|---|
| bool | 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 |
|---|---|
| bool |
Reset()
Resets the enumeration
Declaration
public void Reset()