Class RefError3dPtg
This token contains the last 3D reference or external reference to a cell in a deleted row or column.
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Formula
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Token(FormulaToken.tRefErr3d1)]
[Token(FormulaToken.tRefErr3d2)]
[Token(FormulaToken.tRefErr3d3)]
[CLSCompliant(false)]
public class RefError3dPtg : Ref3DPtg, ICloneable, IRangeGetterToken, IToken3D, IRectGetter, ISheetReference, IReference, IRangeGetterConstructors
RefError3dPtg()
Default constructor. To prevent user from creating a token without parameters and to allow descendants do this.
Declaration
public RefError3dPtg()RefError3dPtg(DataProvider, Int32, ExcelVersion)
Creates token using data from an array of bytes.
Declaration
public RefError3dPtg(DataProvider provider, int offset, ExcelVersion version)Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Object that provides access to the data. |
| System.Int32 | offset | Offset to token data. |
| ExcelVersion | version | Excel version that was used to infill data provider. |
RefError3dPtg(Ref3DPtg)
Creates error token based on Ref3D token.
Declaration
public RefError3dPtg(Ref3DPtg dataHolder)Parameters
| Type | Name | Description |
|---|---|---|
| Ref3DPtg | dataHolder | Token to get data from. |
RefError3dPtg(String, IWorkbook)
Creates token by its string representation.
Declaration
public RefError3dPtg(string strFormula, IWorkbook parent)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strFormula | String representation of the token. |
| IWorkbook | parent | Workbook that contains this reference. |
Methods
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)
Returns token code by index.
Declaration
public static FormulaToken IndexToCode(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index of the token code. |
Returns
| Type | Description |
|---|---|
| FormulaToken | Required token code. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | When index is less than 1 or greater than 3. |
Offset(Int32, Int32, Int32, Int32, Rectangle, Int32, Rectangle, out Boolean, WorkbookImpl)
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 | |
| System.Drawing.Rectangle | rectSource | |
| System.Int32 | iDestSheetIndex | |
| System.Drawing.Rectangle | rectDest | |
| System.Boolean | bChanged | |
| WorkbookImpl | book | Parent workbook. |
Returns
| Type |
|---|
| Ptg |
Overrides
ToString()
Converts token to string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | String representation of this token. |
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. |