Class PivotNameRecord
This record stores a PivotTable name.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class PivotNameRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
PivotNameRecord()
Default constructor.
Declaration
public PivotNameRecord()
PivotNameRecord(Int32)
Reserved for record's internal data array.
Declaration
public PivotNameRecord(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. |
PivotNameRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public PivotNameRecord(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
AggregateField
Field to aggregate in calculated field formulas.
Declaration
public ushort AggregateField { get; set; }
Property Value
Type |
---|
System.UInt16 |
AggregateFunction
Function to use for aggregation in calculated field formulas.
Declaration
public ushort AggregateFunction { get; set; }
Property Value
Type |
---|
System.UInt16 |
IsErrorName
If it is set to true then the name is invalid and should be displayed and evaluated as #NAME.
Declaration
public bool IsErrorName { get; set; }
Property Value
Type |
---|
System.Boolean |
Options
Option flags. Read-only.
Declaration
public ushort Options { get; }
Property Value
Type |
---|
System.UInt16 |
PairCount
Number of SXPAIR records to follow this record.
Declaration
public ushort PairCount { 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. 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. |