Class DataItemRecord

Summary description for DataItem.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
BiffRecordRawWithArray
DataItemRecord
Implements
System.ICloneable
System.IDisposable
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.DataItem)]
[CLSCompliant(false)]
public class DataItemRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable

Constructors

DataItemRecord()

Default constructor.

Declaration
public DataItemRecord()

DataItemRecord(Int32)

Reserved for record's internal data array.

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

DataItemRecord(Stream, out Int32)

Read / initialize constructor.

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

DisplayFormat

Data display format: 0 - Normal, 1 - Diffrence from, 2 - Percentage of, 3 - Percentage difference from, 4 - Running total in, 5 - Percentage of row, 6 - Percentage of column, 7 - Percentage of total, 8 - Index.

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

Field

Field that this data item is based on.

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

FormatTableIndex

Index to the format table for this item.

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

FunctionIndex

Index to the aggregation function: 0 - Sum, 1 - Count, 2 - Average, 3 - Max, 4 - Min, 5 - Product, 6 - Count Nums, 7 - StdDev, 8 - StdDevp, 9 - Var, 10 - Varp,

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

Name

Name of the item.

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

NameLength

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

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

ViewFieldIndex

Index to the SXVD record used by the data display format.

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

ViewItemIndex

Index to the SXVI record used by the data display format.

Declaration
public ushort ViewItemIndex { get; set; }
Property Value
Type Description
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