Class NamePtg
This token contains the one-based index to a NAME record.
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Formula
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Token]
[Token]
[Token]
public class NamePtg : Ptg, ICloneable, IRangeGetter
Constructors
NamePtg()
Default constructor. To prevent user from creating a token without parameters and to allow descendants do this.
Declaration
public NamePtg()
NamePtg(DataProvider, Int32, ExcelVersion)
Constructs token using data from a byte array.
Declaration
public NamePtg(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. |
NamePtg(Int32)
Creates token by name index.
Declaration
public NamePtg(int iNameIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iNameIndex | Name index. |
NamePtg(String, IWorkbook)
Creates token by its string representation.
Declaration
public NamePtg(string strFormula, IWorkbook parent)
Parameters
Type | Name | Description |
---|---|---|
System.String | strFormula | String representation of the token. |
IWorkbook | parent | Workbook that contains this reference. |
NamePtg(String, IWorkbook, IWorksheet)
Creates token by its string representation.
Declaration
public NamePtg(string strFormula, IWorkbook book, IWorksheet sheet)
Parameters
Type | Name | Description |
---|---|---|
System.String | strFormula | String representation of the token. |
IWorkbook | book | Workbook that contains this reference. |
IWorksheet | sheet | Worksheet that contains this reference. |
Properties
ExternNameIndex
Gets / sets one-based index of ExternNameRecord.
Declaration
public ushort ExternNameIndex { get; set; }
Property Value
Type |
---|
System.UInt16 |
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 | Parent sheet. |
Returns
Type | Description |
---|---|
IRange | Range represented by the token. |
GetRectangle()
Returns rectangle represented by the token that implements this interface.
Declaration
public Rectangle GetRectangle()
Returns
Type | Description |
---|---|
Rectangle | Rectangle represented by the token. |
GetSize(ExcelVersion)
Read-only. Size of the token.
Declaration
public override int GetSize(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type |
---|
System.Int32 |
Overrides
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. |
InfillPTG(DataProvider, ref Int32, ExcelVersion)
Infill PTG structure.
Declaration
public override void InfillPTG(DataProvider provider, ref int offset, ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
DataProvider | provider | Represents storage. |
System.Int32 | offset | Offset in storage. |
ExcelVersion | version | Excel version that was used to infill data provider. |
Overrides
ToByteArray(ExcelVersion)
Converts token to array of bytes.
Declaration
public override byte[] ToByteArray(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type | Description |
---|---|
System.Byte[] | Array of bytes representing this token. |
Overrides
ToString()
Converts token to string.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String representation of the 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. |