Class PivotFormatRecord
This record stores formatting data.
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
[Biff(TBIFFRecord.PivotFormat)]
[CLSCompliant(false)]
public class PivotFormatRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
PivotFormatRecord()
Default constructor.
Declaration
public PivotFormatRecord()
PivotFormatRecord(Stream, out int)
Read / initialize constructor.
Declaration
public PivotFormatRecord(Stream stream, out int itemSize)
Parameters
| Type | Name | Description |
|---|---|---|
| Stream | stream | Stream from which record data should be read. |
| int | itemSize | Size of read item. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | When stream is not specified. |
| ApplicationException | When stream does not support read or seek operations. |
PivotFormatRecord(int)
Reserved for record's internal data array.
Declaration
public PivotFormatRecord(int iReserve)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iReserve | Amount of bytes for the data array. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | If amount of bytes requested is less than zero. |
Properties
DataSize
Length of data.
Declaration
public ushort DataSize { get; set; }
Property Value
| Type |
|---|
| ushort |
Type
0 - clear, 1 - format applied.
Declaration
public ushort Type { get; set; }
Property Value
| Type |
|---|
| ushort |
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 |
|---|---|
| int | Size of the required storage space. |
Overrides
ParseStructure(DataProvider, int, int, 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. |
| int | iOffset | Offset to the record's data. |
| int | iLength | Length of the record's data. |
| ExcelVersion | version | Excel version used for infill. |