Class PivotStringRecord

This record contains an SQL query string, an SQL server connection string or page item name from a multiple-consolidation PivotTable.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
PivotStringRecord
Implements
System.ICloneable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.PivotString)]
[CLSCompliant(false)]
public class PivotStringRecord : BiffRecordRaw, ICloneable, IBiffStorage, IValueHolder

Constructors

PivotStringRecord()

Default constructor.

Declaration
public PivotStringRecord()

PivotStringRecord(Int32)

Reserved for record's internal data array.

Declaration
public PivotStringRecord(int iReserve)
Parameters
Type Name Description
System.Int32 iReserve

Amount of bytes for the data array.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

If amount of bytes requested is less than zero.

PivotStringRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public PivotStringRecord(Stream stream, out int itemSize)
Parameters
Type Name Description
System.IO.Stream stream

Stream from which record data should be read.
System.Int32 itemSize

Size of read item.
Exceptions
Type Condition
System.ArgumentNullException

When stream is not specified.
System.ApplicationException

When stream does not support read or seek operations.

Properties

NeedDataArray

Indicates whether data array is required by this record. Read-only.

Declaration
public override bool NeedDataArray { get; }
Property Value
Type Description
System.Boolean
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.NeedDataArray

String

String value.

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

Methods

GetStoreSize(ExcelVersion)

Evaluates size of the required storage space.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type Description
System.Int32

Size of the required storage space.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Converts data buffer to special values according to record specification.

Declaration
public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
Parameters
Type Name Description
DataProvider provider

Object that provides access to the data.
System.Int32 iOffset

Offset to the record's data.
System.Int32 iLength

Length of the record's data.
ExcelVersion version

Excel version used for infill.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Explicit Interface Implementations

IValueHolder.Value

Value of the record.

Declaration
object IValueHolder.Value { get; set; }
Returns
Type Description
System.Object

Implements

System.ICloneable