Class PivotViewDefinitionRecord

This record contains top-level PivotTable information.

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

Constructors

PivotViewDefinitionRecord()

Default constructor.

Declaration
public PivotViewDefinitionRecord()

PivotViewDefinitionRecord(Int32)

Reserved for record's internal data array.

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

PivotViewDefinitionRecord(Stream, out Int32)

Read / initialize constructor.

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

AutoFormatIndex

Index to the PivotTable autoformat.

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

CacheIndex

Index to the cache.

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

ColumnFieldsNumber

Number of column fields.

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

DataAxis

Default axis for a data field.

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

DataColumnsNumber

Number of data columns.

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

DataFieldName

Name of the data field.

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

DataFieldNameLength

Length of the data field name. Read-only.

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

DataFieldsNumber

Number of data fields.

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

DataPos

Default position for a data field.

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

DataRowsNumber

Number of data rows.

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

FieldsNumber

Number of fields.

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

FirstColumn

First column of the PivotTable.

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

FirstDataColumn

First column containing PivotTable data.

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

FirstDataRow

First row containing PivotTable data.

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

FirstHeadRow

First row containing PivotTable headings.

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

FirstRow

First row of the PivotTable.

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

IsAlignAutoFormat

Indicates whether the alignment autoformat is applied.

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

IsAutoFormat

Indicates whether the PivotTable has an autoformat applied.

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

IsBorderAutoFormat

Indicates whether the Border autoformat is applied.

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

IsColumnGrand

Indicates whether the PivotTable contains grand totals for columns.

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

IsFontAutoFormat

Indicates whether the font autoformat is applied.

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

IsNumberAutoFormat

Indicates whether the PivotTable has an autoformat applied.

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

IsPatternAutoFormat

Indicates whether the pattern autoformat is applied.

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

IsRowGrand

Indicates whether the PivotTable contains grand totals for rows.

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

IsWHAutoFormat

Indicates whether the width / height autoformat is applied.

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

LastColumn

Last column of the PivotTable.

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

LastRow

Last row of the PivotTable.

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

Options

Option flags. Read-only.

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

PageFieldsNumber

Number of page fields.

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

Reserved

Reserved. Must be zero. Read-only.

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

RowFieldsNumber

Number of row fields.

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

TableName

PivotTable name.

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

TableNameLength

Length of the PivotTable name. Read-only.

Declaration
public ushort TableNameLength { get; }
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