Class PivotCacheFieldImpl

Represents single pivot field in the pivot cache.

Inheritance

System.Object

PivotCacheFieldImpl

Namespace: Syncfusion.XlsIO.Implementation.PivotTables

Assembly: Syncfusion.XlsIO.NET.dll

Syntax

public class PivotCacheFieldImpl : Object

Constructors

PivotCacheFieldImpl()

Initializes a new instance of Pivot cache field.

Declaration

public PivotCacheFieldImpl()

PivotCacheFieldImpl(BiffReader)

Initializes a new instance of pivot cache field and extracts its values from BiffReader.

Declaration

public PivotCacheFieldImpl(BiffReader reader)

Parameters

Type	Name	Description
BiffReader	reader	Reader to get data from.

Properties

CalculatedItems

Gets items within a PivotTable field that uses formula.

Declaration

public PivotCalculatedItems CalculatedItems { get; }

Property Value

Type
PivotCalculatedItems

Caption

Gets or sets the caption of the cache field.

Declaration

public string Caption { get; set; }

Property Value

Type
System.String

DataType

Gets the type of the field's data. Read-only.

Declaration

public PivotDataType DataType { get; }

Property Value

Type
PivotDataType

Formula

Gets or sets the formula for the calculated field

Declaration

public string Formula { get; set; }

Property Value

Type
System.String

Index

Gets or sets the index of this field in the parent collection.

Declaration

public int Index { get; set; }

Property Value

Type
System.Int32

IsDataBaseField

Gets or sets a Boolean value indicating whether this field came from the source database.

Declaration

public Nullable<bool> IsDataBaseField { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

IsDate

True if the cache filed is a date. False otherwise.

Declaration

public bool IsDate { get; }

Property Value

Type
System.Boolean

IsDouble

True if the cache field is a double value. False otherwise.

Declaration

public bool IsDouble { get; set; }

Property Value

Type
System.Boolean

IsDoubleInt

True if the cache field is a double or int value. False otherwise.

Declaration

public bool IsDoubleInt { get; set; }

Property Value

Type
System.Boolean

IsFieldGroup

True if the cache field is Field group. False otherwise.

Declaration

public bool IsFieldGroup { get; }

Property Value

Type
System.Boolean

IsFormulaField

True if the cache field is formula field. False otherwise.

Declaration

public bool IsFormulaField { get; }

Property Value

Type
System.Boolean

IsInIndexList

True if the cache field is present in the index list. False otherwise.

Declaration

public bool IsInIndexList { get; set; }

Property Value

Type
System.Boolean

IsLongIndex

True if the cache field has a long index. False otherwise.

Declaration

public bool IsLongIndex { get; set; }

Property Value

Type
System.Boolean

IsParsed

Gets or sets a Boolean value indicating whether the shared items are parsed.

Declaration

public Nullable<bool> IsParsed { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

IsString

True if the cache field is a string. False otherwise.

Declaration

public bool IsString { get; set; }

Property Value

Type
System.Boolean

IsUnknown

True if the cache field is unknown. False Otherwise.

Declaration

public bool IsUnknown { get; set; }

Property Value

Type
System.Boolean

IsUnknown2

True if the cache field is unknown2. False Otherwise.

Declaration

public bool IsUnknown2 { get; set; }

Property Value

Type
System.Boolean

ItemCount

Gets the items in the pivot cache field. Read-only.

Declaration

public int ItemCount { get; }

Property Value

Type
System.Int32

Name

Gets or sets teh anme of the pivot cache field.

Declaration

public string Name { get; set; }

Property Value

Type
System.String

NumFormatIndex

Gets or sets the number format that is applied to all items in the field.

Declaration

public int NumFormatIndex { get; set; }

Property Value

Type
System.Int32

ParentFeildGroupIndex

Gets or sets the field group index.

Declaration

public int ParentFeildGroupIndex { get; set; }

Property Value

Type
System.Int32

Methods

GetValue(Int32)

Gets item at the specified index.

Declaration

public object GetValue(int index)

Parameters

Type	Name	Description
System.Int32	index	Index of the value to get.

Returns

Type	Description
System.Object	Requested value.

Parse(BiffReader)

Parses pivot cache field.

Declaration

public void Parse(BiffReader reader)

Parameters

Type	Name	Description
BiffReader	reader	Reader to extract data from.

Serialize(OffsetArrayList)

Serializes pivot cache field into list of Biff records.

Declaration

public void Serialize(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList to serialize into.