Class PivotViewFieldsExRecord

This record contains extended PivotTable view fields information.

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

Constructors

PivotViewFieldsExRecord()

Default constructor.

Declaration
public PivotViewFieldsExRecord()

PivotViewFieldsExRecord(Int32)

Reserved for record's internal data array.

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

PivotViewFieldsExRecord(Stream, out Int32)

Read / initialize constructor.

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

IsAscendShow

Show top values.

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

IsAscendSort

Autosort ascending.

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

IsAutoShow

Autoshow is enabled.

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

IsAutoSort

Autosort is enabled.

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

IsCalculateField

Calculated field.

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

IsDragToColumn

User can drag field to column area.

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

IsDragToHide

User can remove field from fiew.

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

IsDragToPage

User can drag field to page area.

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

IsDragToRow

User can drag field to row area.

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

IsServerBased

This field is a server-based field in the page area.

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

IsShowAllItems

Show all items for this field.

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

ItemsNumber

Number of items to show for AutoShow, default is 10.

Declaration
public byte ItemsNumber { get; set; }
Property Value
Type Description
System.Byte

NumberFormat

Number format of field or 0 if none.

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

Options

Option flags. Read-only.

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

Reserved

Reserved. Read-only.

Declaration
public byte Reserved { get; }
Property Value
Type Description
System.Byte

ShowIndex

0-based index of data field that AutoShow is based on.

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

SortIndex

0-based index of data field that AutoSort is based on or 0xFFFF for current field.

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

SubTotalName

Specifies the custom text that is displayed for the subtotals label.

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

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