Class SortAxisDescriptorCollection

Represents a collection of PivotSortDescriptor for sorting PivotAxisItems .

Inheritance
System.Object
SortAxisDescriptorCollection
Implements
System.IDisposable
System.Collections.ICollection
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.PivotChart
Assembly: Syncfusion.PivotChart.Windows.dll
Syntax
public class SortAxisDescriptorCollection : IDisposable, ICollection, IEnumerable

Constructors

SortAxisDescriptorCollection(PivotChart)

Initialize a new instance for SortAxisDescriptorCollection class.

Declaration
public SortAxisDescriptorCollection(PivotChart pivotchart)
Parameters
Type Name Description
PivotChart pivotchart

The PivotChartclass object.

Properties

Count

Gets the number of elements contained in the collection.

Declaration
public int Count { get; }
Property Value
Type
System.Int32

IsFixedSize

Gets a value indicating whether this collection has fixed size or not.

Declaration
public bool IsFixedSize { get; }
Property Value
Type
System.Boolean

IsReadOnly

Gets a value indicating whether the collection is read-only or not. Returns False.

Declaration
public bool IsReadOnly { get; }
Property Value
Type
System.Boolean

IsSynchronized

Gets a value indicating whether the collection is Synchronized or not. Returns False.

Declaration
public bool IsSynchronized { get; }
Property Value
Type
System.Boolean

Item[Int32]

Gets or sets the element at the zero-based index.

Declaration
public PivotSortDescriptor this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index

The zero-based index of the element
Property Value
Type Description
PivotSortDescriptor

The PivotSortDescriptor element.

Methods

Add(PivotSortDescriptor)

Adds an object to the end of the collection.

Declaration
public void Add(PivotSortDescriptor value)
Parameters
Type Name Description
PivotSortDescriptor value

The element to be added to the end of the collection. The value must not be a NULL reference.

Clear()

Removes all elements from the collection.

Declaration
public void Clear()

Contains(PivotSortDescriptor)

Determines a value indicating whether an element with the given name belongs to this PivotSortingDescriptor collection or not.

Declaration
public bool Contains(PivotSortDescriptor value)
Parameters
Type Name Description
PivotSortDescriptor value

The PivotSortDescriptor value.
Returns
Type Description
System.Boolean

True if item is found in the collection; otherwise, False.

Contains(String)

Determines a value indicating whether an element with the given name belongs to this PivotSortingDescriptor collection or not.

Declaration
public bool Contains(string name)
Parameters
Type Name Description
System.String name

The pivotItem fieldMappingName.
Returns
Type Description
System.Boolean

True if item is found in the collection; otherwise, False.

CopyTo(PivotSortDescriptor[], Int32)

Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

Declaration
public void CopyTo(PivotSortDescriptor[] array, int index)
Parameters
Type Name Description
PivotSortDescriptor[] array

The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.
System.Int32 index

The zero-based index in an array at which copying begins.

Dispose()

Disposes the unmanaged resources.

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool isDisposing)
Parameters
Type Name Description
System.Boolean isDisposing

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration
public IEnumerator GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

An Enumerator for the entire collection.

IndexOf(PivotSortDescriptor)

Gets the zero-based index of the occurrence of the element in the collection.

Declaration
public int IndexOf(PivotSortDescriptor value)
Parameters
Type Name Description
PivotSortDescriptor value

The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).
Returns
Type Description
System.Int32

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

Insert(Int32, PivotSortDescriptor)

Inserts a descriptor element into the collection at the specified index.

Declaration
public void Insert(int index, PivotSortDescriptor value)
Parameters
Type Name Description
System.Int32 index

The zero-based index at which the element should be inserted.
PivotSortDescriptor value

The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

Remove(PivotSortDescriptor)

Removes the specified descriptor element from the collection.

Declaration
public void Remove(PivotSortDescriptor value)
Parameters
Type Name Description
PivotSortDescriptor value

The element to remove from the collection. If the value is NULL or the element is not contained in the collection, the method will do nothing.

RemoveAt(Int32)

Removes the element at the specified index of the collection.

Declaration
public void RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

The zero-based index of the element to remove.

Events

Changed

Occurs after a property in a nested element or the collection is changed.

Declaration
public event PivotItemSortedEventHandler Changed
Event Type
Type
PivotItemSortedEventHandler

Changing

Occurs before a property in a nested element or the collection is changed.

Declaration
public event PivoItemSortingEventHandler Changing
Event Type
Type
PivoItemSortingEventHandler

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the entire collection to a compatible one-dimensional array.

Declaration
void ICollection.CopyTo(Array array, int index)
Parameters
Type Name Description
System.Array array
System.Int32 index

ICollection.SyncRoot

Throws the NotImplementedException.

Declaration
object ICollection.SyncRoot { get; }
Returns
Type
System.Object

IEnumerable.GetEnumerator()

Throws the NotImplementedException.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type
System.Collections.IEnumerator

Implements

System.IDisposable
System.Collections.ICollection
System.Collections.IEnumerable

Extension Methods