Class ControlPtg
This class represents the control token (this can be tExp or tTbl).
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Formula
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Token]
[Token]
public class ControlPtg : RefPtg, ICloneable, IRangeGetterToken, IRangeGetter, IRectGetter, IToken3D
Constructors
ControlPtg()
Default constructor. To prevent user from creating a token without parameters and to allow descendants do this.
Declaration
public ControlPtg()
ControlPtg(DataProvider, Int32, ExcelVersion)
Constructs token from byte array.
Declaration
public ControlPtg(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. |
ControlPtg(Int32, Int32)
Declaration
public ControlPtg(int iRow, int iColumn)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iRow | |
System.Int32 | iColumn |
Properties
IsColumnIndexRelative
Declaration
public override bool IsColumnIndexRelative { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
IsRowIndexRelative
Declaration
public override bool IsRowIndexRelative { get; set; }
Property Value
Type |
---|
System.Boolean |
Overrides
Methods
GetCorrespondingErrorCode()
Declaration
public override FormulaToken GetCorrespondingErrorCode()
Returns
Type |
---|
FormulaToken |
Overrides
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
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
MoveIntoDifferentSheet(RefPtg, Int32, Rectangle, Int32, Int32, Int32, WorkbookImpl)
Moves token into different worksheet.
Declaration
protected override Ptg MoveIntoDifferentSheet(RefPtg result, int iSourceSheetIndex, Rectangle rectSource, int iDestSheetIndex, int iRowOffset, int iColOffset, WorkbookImpl book)
Parameters
Type | Name | Description |
---|---|---|
RefPtg | result | Token to move |
System.Int32 | iSourceSheetIndex | Source sheet index. |
Rectangle | rectSource | Source rectangle. |
System.Int32 | iDestSheetIndex | Destination sheet index. |
System.Int32 | iRowOffset | Row offset. |
System.Int32 | iColOffset | Column offset. |
WorkbookImpl | book | Parent workbook. |
Returns
Type | Description |
---|---|
Ptg | Modified token. |
Overrides
ToByteArray(ExcelVersion)
Converts token to byte array.
Declaration
public override byte[] ToByteArray(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type | Description |
---|---|
System.Byte[] | Array of bytes that represents 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. |