Class PivotNamePairRecord

Summary description for PivotNamePairRecord.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
PivotNamePairRecord
Implements
System.ICloneable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.PivotNamePair)]
[CLSCompliant(false)]
public class PivotNamePairRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

PivotNamePairRecord()

Default constructor.

Declaration
public PivotNamePairRecord()

PivotNamePairRecord(Int32)

Reserved for record's internal data array.

Declaration
public PivotNamePairRecord(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.

PivotNamePairRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public PivotNamePairRecord(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

Cache

Index of item in field.

Declaration
public ushort Cache { get; set; }
Property Value
Type Description
System.UInt16

Field

Field.

Declaration
public ushort Field { get; set; }
Property Value
Type Description
System.UInt16

IsCalculatedItem

Declaration
public bool IsCalculatedItem { get; set; }
Property Value
Type Description
System.Boolean

IsPhysical

Indicates whether item is referred to by position (physical) rather than by name (logical).

Declaration
public bool IsPhysical { get; set; }
Property Value
Type Description
System.Boolean

IsRelative

Indicates whether item is referred to using relative references rather than absolute references.

Declaration
public bool IsRelative { get; set; }
Property Value
Type Description
System.Boolean

Options

Option flags.

Declaration
public ushort Options { get; }
Property Value
Type Description
System.UInt16

Reserved

Reserved, should be set to zero. Read-only.

Declaration
public ushort Reserved { get; }
Property Value
Type Description
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
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

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.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Implements

System.ICloneable