Class PivotFieldRecord
Summary description for PivotFieldRecord.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class PivotFieldRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
PivotFieldRecord()
Default constructor.
Declaration
public PivotFieldRecord()
PivotFieldRecord(Int32)
Reserved for record's internal data array.
Declaration
public PivotFieldRecord(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. |
PivotFieldRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public PivotFieldRecord(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
IsDate
Indicates whether field can contain date values.
Declaration
public bool IsDate { get; set; }
Property Value
Type |
---|
System.Boolean |
IsDouble
Indicates whether field can contain double values.
Declaration
public bool IsDouble { get; set; }
Property Value
Type |
---|
System.Boolean |
IsDoubleInt
Indicates whether field can contain double values without fraction.
Declaration
public bool IsDoubleInt { get; set; }
Property Value
Type |
---|
System.Boolean |
IsInIndexList
Declaration
public bool IsInIndexList { get; set; }
Property Value
Type |
---|
System.Boolean |
IsLongIndex
Declaration
public bool IsLongIndex { get; set; }
Property Value
Type |
---|
System.Boolean |
IsNotInList
Declaration
public bool IsNotInList { get; set; }
Property Value
Type |
---|
System.Boolean |
IsString
Indicates whether field can contain string values.
Declaration
public bool IsString { get; set; }
Property Value
Type |
---|
System.Boolean |
IsUnknown
Unknown flag.
Declaration
public bool IsUnknown { get; set; }
Property Value
Type |
---|
System.Boolean |
IsUnknown2
Unknown flag.
Declaration
public bool IsUnknown2 { get; set; }
Property Value
Type |
---|
System.Boolean |
ItemCount1
First item count.
Declaration
public ushort ItemCount1 { get; set; }
Property Value
Type |
---|
System.UInt16 |
ItemCount2
Second item count.
Declaration
public ushort ItemCount2 { get; set; }
Property Value
Type |
---|
System.UInt16 |
MinimumRecordSize
Read-only. Returns minimum possible size of record's internal data array.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
Name
Field name.
Declaration
public string Name { get; set; }
Property Value
Type |
---|
System.String |
Options
Option flags.
Declaration
public ushort Options { get; }
Property Value
Type |
---|
System.UInt16 |
Reserved1
Unknown.
Declaration
public uint Reserved1 { get; set; }
Property Value
Type |
---|
System.UInt32 |
Reserved2
Unknown.
Declaration
public uint Reserved2 { get; set; }
Property Value
Type |
---|
System.UInt32 |
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. |