Class AreaError3DPtg
Summary description for AreaError3dPtg.
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Formula
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Token]
[Token]
[Token]
public class AreaError3DPtg : Area3DPtg, ICloneable, IRangeGetterToken, IRectGetter, IToken3D, ISheetReference, IReference, IRangeGetter
Constructors
AreaError3DPtg()
Default constructor. To prevent user from creating a token without parameters and to allow descendants do this.
Declaration
public AreaError3DPtg()
AreaError3DPtg(DataProvider, Int32, ExcelVersion)
Creates token using data from array of bytes.
Declaration
public AreaError3DPtg(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. |
AreaError3DPtg(Area3DPtg)
Declaration
public AreaError3DPtg(Area3DPtg ptg)
Parameters
Type | Name | Description |
---|---|---|
Area3DPtg | ptg |
AreaError3DPtg(String, IWorkbook)
Declaration
public AreaError3DPtg(string value, IWorkbook book)
Parameters
Type | Name | Description |
---|---|---|
System.String | value | |
IWorkbook | book |
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 tAreaErr3d1, tAreaErr3d2, tAreaErr3d3. |
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 the token code.
Declaration
public static FormulaToken IndexToCode(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Function parameter index. |
Returns
Type | Description |
---|---|
FormulaToken | Token code that corresponds to the specified index. |
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)
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. |