PivotFieldBaseCollection Class

Namespace:
GemBox.Spreadsheet.PivotTables
Assembly:
GemBox.Spreadsheet.dll

Represents a base collection of PivotFields.

public abstract class PivotFieldBaseCollection : IEnumerable<PivotField>, IEnumerable
Public MustInherit Class PivotFieldBaseCollection
    Implements IEnumerable(Of PivotField), IEnumerable
Inheritance:
System.Object
PivotFieldBaseCollection
Derived
PivotAreaFieldCollection
PivotFieldCollection
Implements
System.Collections.Generic.IEnumerable<PivotField>
System.Collections.IEnumerable

Properties

Count

Gets the number of PivotFields contained in the collection.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

The number of PivotFields contained in the collection.

Item[Int32]

Gets the PivotField at the specified index.

public PivotField this[int index] { get; }
Public ReadOnly Property Item(index As Integer) As PivotField
Parameters
index
System.Int32

The zero-based index of the PivotField.

Property Value
PivotField

The PivotField at the specified index.

Item[String]

Gets the PivotField with the specified name.

public PivotField this[string fieldName] { get; }
Public ReadOnly Property Item(fieldName As String) As PivotField
Parameters
fieldName
System.String

The name of the PivotField.

Property Value
PivotField

The PivotField with the specified name.

Methods

Contains(PivotField)

Determines whether the PivotField is contained in the collection.

public bool Contains(PivotField item)
Public Function Contains(item As PivotField) As Boolean
Parameters
item
PivotField

The PivotField to locate in the collection.

Returns
System.Boolean

true if PivotField is contained in the collection; otherwise, false.

GetEnumerator()

Returns an enumerator for the collection.

public IEnumerator<PivotField> GetEnumerator()
Public Function GetEnumerator As IEnumerator(Of PivotField)
Returns
System.Collections.Generic.IEnumerator<PivotField>

An enumerator for the collection.

IndexOf(PivotField)

Searches for the specified PivotField and returns the zero-based index of the first occurrence within the entire collection.

public int IndexOf(PivotField item)
Public Function IndexOf(item As PivotField) As Integer
Parameters
item
PivotField

The PivotField to locate in the collection.

Returns
System.Int32

The zero-based index of the first occurrence of PivotField within the entire collection, if found; otherwise, –1.

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable