Class AreaNPtg
This token contains the reference to a cell range in the same sheet.
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Formula
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Token(FormulaToken.tAreaN2)]
[Token(FormulaToken.tAreaN3)]
[CLSCompliant(false)]
[Token(FormulaToken.tAreaN1)]
public class AreaNPtg : AreaPtg, ICloneable, IRangeGetterToken, IRangeGetter, IToken3D, IRectGetter
Constructors
AreaNPtg()
Default constructor. To prevent user from creating tokens without parameters and to allow descendants.
Declaration
public AreaNPtg()
AreaNPtg(DataProvider, Int32, ExcelVersion)
Creates token using data from an array of bytes.
Declaration
public AreaNPtg(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. |
AreaNPtg(String, IWorkbook)
Creates token by its string representation.
Declaration
public AreaNPtg(string strFormula, IWorkbook book)
Parameters
Type | Name | Description |
---|---|---|
System.String | strFormula | String representation of the formula. |
IWorkbook | book | Parent workbook. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | When specified string is not a valid token string. |
Properties
FirstColumn
First column offset (-128..127).
Declaration
public short FirstColumn { get; set; }
Property Value
Type |
---|
System.Int16 |
LastColumn
Column offset (-128..127).
Declaration
public short LastColumn { get; set; }
Property Value
Type |
---|
System.Int16 |
Methods
CodeToIndex(FormulaToken)
Converts token code to index (inverse operation to IndexToCode).
Declaration
public static int CodeToIndex(FormulaToken token)
Parameters
Type | Name | Description |
---|---|---|
FormulaToken | token | Token code (should be one of tAreaN1, tAreaN2, tAreaN3). |
Returns
Type | Description |
---|---|
System.Int32 | Reference index. |
ConvertSharedToken(IWorkbook, Int32, Int32)
Converts token from shared formula into token from regular formula.
Declaration
public override Ptg ConvertSharedToken(IWorkbook parent, int iRow, int iColumn)
Parameters
Type | Name | Description |
---|---|---|
IWorkbook | parent | Parent workbook. |
System.Int32 | iRow | Row index. |
System.Int32 | iColumn | Column index. |
Returns
Type | Description |
---|---|
Ptg | New token for regular formula. |
Overrides
IndexToCode(Int32)
Converts reference index to token code.
Declaration
public static FormulaToken IndexToCode(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Reference index. |
Returns
Type | Description |
---|---|
FormulaToken | Token code. |
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. |