Class PivotViewItemRecord

This record contains information about a PivotTable item.

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

Constructors

PivotViewItemRecord()

Default constructor.

Declaration
public PivotViewItemRecord()

PivotViewItemRecord(Int32)

Reserved for record's internal data array.

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

PivotViewItemRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public PivotViewItemRecord(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 to the PivotTable cache.

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

IsFormula

Indicates whether the item is calculated item.

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

IsHidden

Indicates whether the item is hidden.

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

IsHideDetail

Indicates whether detail is hidden.

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

IsMissing

Indicates whether item is an item that does not exist in any records.

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

ItemType

Item type.

Declaration
public PivotViewItemRecord.ItemTypes ItemType { get; set; }
Property Value
Type
PivotViewItemRecord.ItemTypes

Name

Name.

Declaration
public string Name { get; set; }
Property Value
Type
System.String

NameLength

Length of the name. If it is equal to 0xFFFF, then name is null and the name in the cache is used. Read-only.

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

Options

Option flags. Read-only.

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

Methods

ParseStructure()

Parse structure of record. Convert Data buffer to special values according to record specification.

Declaration
public override void ParseStructure()
Overrides

Implements

System.ICloneable
System.IDisposable