Class AreaErrorPtg
This token contains the last reference to a deleted cell range in the same sheet.
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Formula
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Token]
[Token]
[Token]
public class AreaErrorPtg : AreaPtg, ICloneable, IRangeGetterToken, IRectGetter, IToken3D, IRangeGetter
Constructors
AreaErrorPtg()
Default constructor. To prevent user from creating a token without parameters and to allow descendants do this.
Declaration
public AreaErrorPtg()
AreaErrorPtg(DataProvider, Int32, ExcelVersion)
Creates token using data from array of bytes.
Declaration
public AreaErrorPtg(DataProvider provider, int offset, ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Object that provides access to the data. |
| System.Int32 | offset | Offset to the token data. |
| ExcelVersion | version | Excel version that was used to infill data provider. |
AreaErrorPtg(AreaPtg)
Declaration
public AreaErrorPtg(AreaPtg area)
Parameters
| Type | Name | Description |
|---|---|---|
| AreaPtg | area |
AreaErrorPtg(String, IWorkbook)
Declaration
public AreaErrorPtg(string value, IWorkbook book)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | |
| IWorkbook | book | Parent workbook. |
Methods
CodeToIndex()
Converts token code to index (inverse operation to IndexToCode).
Declaration
public override int CodeToIndex()
Returns
| Type | Description |
|---|---|
| System.Int32 | Reference index. |
Overrides
CodeToIndex(FormulaToken)
Converts specified token code to index.
Declaration
public static int CodeToIndex(FormulaToken code)
Parameters
| Type | Name | Description |
|---|---|---|
| FormulaToken | code | Token code for which index is required. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Index that corresponds to the code. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | When index is not one of tAreaErr1, tAreaErr2, tAreaErr3. |
GetRange(IWorkbook, IWorksheet)
Returns range represented by the token that implements this interface.
Declaration
public IRange GetRange(IWorkbook book, IWorksheet sheet)
Parameters
| Type | Name | Description |
|---|---|---|
| IWorkbook | book | Workbook that contains range. |
| IWorksheet | sheet | Worksheet that contains range. |
Returns
| Type | Description |
|---|---|
| IRange | Range represented by the token. |
IndexToCode(Int32)
Converts specified index to token code.
Declaration
public static FormulaToken IndexToCode(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index of the needed token. |
Returns
| Type | Description |
|---|---|
| FormulaToken | Token that corresponds to the index. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | When index is less than one or greater than 3. |
Offset(Int32, Int32, Int32, Int32, Rectangle, Int32, Rectangle, out Boolean, WorkbookImpl)
Returns Ptg Offset
Declaration
public override Ptg Offset(int iCurSheetIndex, int iTokenRow, int iTokenColumn, int iSourceSheetIndex, Rectangle rectSource, int iDestSheetIndex, Rectangle rectDest, out bool bChanged, WorkbookImpl book)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCurSheetIndex | |
| System.Int32 | iTokenRow | |
| System.Int32 | iTokenColumn | |
| System.Int32 | iSourceSheetIndex | |
| Rectangle | rectSource | |
| System.Int32 | iDestSheetIndex | |
| Rectangle | rectDest | |
| System.Boolean | bChanged | |
| WorkbookImpl | book |
Returns
| Type |
|---|
| Ptg |
Overrides
ToString(FormulaUtil, Int32, Int32, Boolean, NumberFormatInfo, Boolean)
Converts token to a string.
Declaration
public override string ToString(FormulaUtil formulaUtil, int iRow, int iColumn, bool bR1C1, NumberFormatInfo numberFormat, bool isForSerialization)
Parameters
| Type | Name | Description |
|---|---|---|
| FormulaUtil | formulaUtil | Formula util. |
| System.Int32 | iRow | Zero-based row index of the cell that contains this token. |
| System.Int32 | iColumn | Zero-based row index of the cell that contains this token. |
| System.Boolean | bR1C1 | Indicates whether R1C1 notation should be used. |
| System.Globalization.NumberFormatInfo | numberFormat | |
| System.Boolean | isForSerialization |
Returns
| Type | Description |
|---|---|
| System.String | String representation of this token. |