Class StringConstantPtg

This token contains a string constant. The maximum length of the string is 255 characters in BIFF8.

Inheritance
System.Object
Ptg
StringConstantPtg
Implements
System.ICloneable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Formula
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Token(FormulaToken.tStringConstant)]
public class StringConstantPtg : Ptg, ICloneable

Constructors

StringConstantPtg()

Default constructor. To prevent user from creating a token without parameters and to allow descendants do this.

Declaration
public StringConstantPtg()

StringConstantPtg(DataProvider, Int32, ExcelVersion)

Creates token using data from array of bytes.

Declaration
public StringConstantPtg(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.

StringConstantPtg(String)

Constructs token by string value.

Declaration
public StringConstantPtg(string value)
Parameters
Type Name Description
System.String value

Value that will contain this token.

Fields

m_compressed

1 - 2 bytes per character, 0 - 1 byte per character (compressed unicode).

Declaration
public byte m_compressed
Field Value
Type
System.Byte

m_strValue

String value.

Declaration
public string m_strValue
Field Value
Type
System.String

Properties

Value

Gets / sets value of this token (its string constant).

Declaration
public string Value { get; set; }
Property Value
Type
System.String

Methods

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

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 that correspond to 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.
Overrides

Implements

System.ICloneable