Class DataConsolidationInfoRecord
This record stores options from the Consolidate dialog box (Data menu).
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
[Biff]
public class DataConsolidationInfoRecord : BiffRecordRaw, ICloneable, IBiffStorageConstructors
DataConsolidationInfoRecord()
Default constructor.
Declaration
public DataConsolidationInfoRecord()DataConsolidationInfoRecord(Int32)
Reserved for record's internal data array.
Declaration
public DataConsolidationInfoRecord(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. |
DataConsolidationInfoRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public DataConsolidationInfoRecord(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
FunctionIndex
Index to the data consolidation function.
Declaration
public DataConsolidationInfoRecord.FunctionTypes FunctionIndex { get; set; }Property Value
| Type | Description |
|---|---|
| DataConsolidationInfoRecord.FunctionTypes |
IsLeftCat
If it is equal to True then the Left Column option is turned on.
Declaration
public bool IsLeftCat { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsLinkConsol
If it is equal to 1 then the Create Links To Source Data option is turned on.
Declaration
public bool IsLinkConsol { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsTopCat
If it is equal to True then the Top Row option is turned on.
Declaration
public bool IsTopCat { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
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
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. |