Class PivotSourceInfoRecord

This record stores information about multiple-consolidation PivotTable source data.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
PivotSourceInfoRecord
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
[CLSCompliant(false)]
[Biff(TBIFFRecord.PivotSourceInfo)]
public class PivotSourceInfoRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

PivotSourceInfoRecord()

Default constructor.

Declaration
public PivotSourceInfoRecord()

PivotSourceInfoRecord(Int32)

Reserved for record's internal data array.

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

PivotSourceInfoRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public PivotSourceInfoRecord(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

IsAutoPage

Indicates whether the user selected the Create A Single Page Field For Me option in PivotTable Wizard dialog box.

Declaration
public bool IsAutoPage { get; set; }
Property Value
Type Description
System.Boolean

Options

Option flags. Read-only.

Declaration
public ushort Options { get; }
Property Value
Type Description
System.UInt16

PageCount

Count (1-based) of page fields.

Declaration
public ushort PageCount { get; set; }
Property Value
Type Description
System.UInt16

PageItemCount

Count (1-based) of SXTBPG records that follow the DCONREF or DCONNAME records.

Declaration
public ushort PageItemCount { get; set; }
Property Value
Type Description
System.UInt16

RefCount

Count (1-based) of DCONREF or DCONNAME records that follow the SXTBL record.

Declaration
public ushort RefCount { get; set; }
Property Value
Type Description
System.UInt16

Methods

GetStoreSize(ExcelVersion)

Size of the required storage space.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type Description
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Convert 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)

Implements

System.ICloneable