Class RowColumnFiledIdRecord

This record stores an array of field ID numbers (2-byte integers) for the row fields and column fields in a PivotTable. Two RowColumnFieldIdRecords appear in the file: the first contains the array of row field IDs, and the second contains the array of column field IDs.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
RowColumnFiledIdRecord
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)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.RowColumnFieldId)]
[CLSCompliant(false)]
public class RowColumnFiledIdRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

RowColumnFiledIdRecord()

Default constructor.

Declaration
public RowColumnFiledIdRecord()

RowColumnFiledIdRecord(Int32)

Reserved for record's internal data array.

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

RowColumnFiledIdRecord(Stream, out Int32)

Read / initialize constructor.

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

FieldIds

Array of 2-byte integers; contains either row field IDs or column field IDs.

Declaration
public ushort[] FieldIds { get; set; }
Property Value
Type
System.UInt16[]

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)

Implements

System.ICloneable