Class RuleDataRecord
This record stores PivotTable rule data.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class RuleDataRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
RuleDataRecord()
Default constructor.
Declaration
public RuleDataRecord()
RuleDataRecord(Int32)
Reserved for record's internal data array.
Declaration
public RuleDataRecord(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. |
RuleDataRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public RuleDataRecord(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
CurrentField
Current field.
Declaration
public byte CurrentField { get; set; }
Property Value
Type |
---|
System.Byte |
Dim
Position of current field in axis.
Declaration
public byte Dim { get; set; }
Property Value
Type |
---|
System.Byte |
FiltersCount
Number of SXFILT records following this record.
Declaration
public ushort FiltersCount { get; set; }
Property Value
Type |
---|
System.UInt16 |
IsCacheBased
Declaration
public bool IsCacheBased { get; set; }
Property Value
Type |
---|
System.Boolean |
IsColumnArea
Indicates whether current field is in column area.
Declaration
public bool IsColumnArea { get; set; }
Property Value
Type |
---|
System.Boolean |
IsDataArea
Indicates whether current field is in data area.
Declaration
public bool IsDataArea { get; set; }
Property Value
Type |
---|
System.Boolean |
IsGrandColSav
Declaration
public bool IsGrandColSav { get; set; }
Property Value
Type |
---|
System.Boolean |
IsGrandColumn
Indicates whether column grand total is selected.
Declaration
public bool IsGrandColumn { get; set; }
Property Value
Type |
---|
System.Boolean |
IsGrandRow
Indicates whether row grand total is selected.
Declaration
public bool IsGrandRow { get; set; }
Property Value
Type |
---|
System.Boolean |
IsGrandRowSav
Declaration
public bool IsGrandRowSav { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNoData
Indicates whether data is not selected.
Declaration
public bool IsNoData { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNoHeader
Indicates whether header is not selected.
Declaration
public bool IsNoHeader { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPageArea
Indicates whether current field is in page area.
Declaration
public bool IsPageArea { get; set; }
Property Value
Type |
---|
System.Boolean |
IsRowArea
Indicates whether current field is in row area.
Declaration
public bool IsRowArea { get; set; }
Property Value
Type |
---|
System.Boolean |
Options
Option flags. Read-only.
Declaration
public ushort Options { get; }
Property Value
Type |
---|
System.UInt16 |
Reserved
Reserved, must be zero.
Declaration
public ushort Reserved { get; set; }
Property Value
Type |
---|
System.UInt16 |
RuleType
Declaration
public ushort RuleType { 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
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. |