WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SortLegendDescriptorCollection

    Show / Hide Table of Contents

    Class SortLegendDescriptorCollection

    Represents a collection ofPivotSortDescriptor for sorting PivotLegends.

    Inheritance
    System.Object
    SortLegendDescriptorCollection
    Implements
    System.IDisposable
    System.Collections.ICollection
    System.Collections.IEnumerable
    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.Windows.Forms.PivotChart
    Assembly: Syncfusion.PivotChart.Windows.dll
    Syntax
    public class SortLegendDescriptorCollection : IDisposable, ICollection, IEnumerable

    Constructors

    SortLegendDescriptorCollection(PivotChart)

    Initialize a new instance for SortLegendDescriptorCollection class.

    Declaration
    public SortLegendDescriptorCollection(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 Description
    System.Int32

    IsFixedSize

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

    Declaration
    public bool IsFixedSize { get; }
    Property Value
    Type Description
    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 Description
    System.Boolean

    IsSynchronized

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

    Declaration
    public bool IsSynchronized { get; }
    Property Value
    Type Description
    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

    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 fieldMappingname)
    Parameters
    Type Name Description
    System.String fieldMappingname

    The PivotItem's FieldMappingName.

    Returns
    Type Description
    System.Boolean

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

    CopyTo(Array, Int32)

    Throws the NotImplementedException.

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

    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 Description
    PivotItemSortedEventHandler

    Changing

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

    Declaration
    public event PivoItemSortingEventHandler Changing
    Event Type
    Type Description
    PivoItemSortingEventHandler

    Explicit Interface Implementations

    ICollection.SyncRoot

    Throws the NotImplementedException.

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

    IEnumerable.GetEnumerator()

    Throws the NotImplementedException.

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

    Implements

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

    Extension Methods

    EnumerableExtensions.GetElementType(IEnumerable)
    EnumerableExtensions.GetItemPropertyInfo(IEnumerable)
    FunctionalExtensions.ForEach<T>(IEnumerable, Action<T>)
    FunctionalExtensions.ToList<T>(IEnumerable)
    QueryableExtensions.OfQueryable(IEnumerable)
    QueryableExtensions.OfQueryable(IEnumerable, Type)
    QueryableExtensions.GroupByMany<TElement>(IEnumerable, Type, List<Func<TElement, Object>>)
    QueryableExtensions.GroupByMany(IEnumerable, Type, Func<String, Expression>, String[])
    QueryableExtensions.GroupByMany(IEnumerable, Type, List<SortDescriptor>, Dictionary<String, IComparer<Object>>, Func<String, Expression>, String[])
    QueryableExtensions.GroupByMany(IEnumerable, Type, List<SortDescriptor>, Func<String, Expression>, String[])
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved