WinForms

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

    Show / Hide Table of Contents

    Class ConditionalFormatDataBarRuleCollection

    A collection which hold the conditionalDataBarRule objects.

    Inheritance
    System.Object
    ConditionalFormatDataBarRuleCollection
    Implements
    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Grid.Grouping
    Assembly: Syncfusion.Grid.Grouping.Windows.dll
    Syntax
    public class ConditionalFormatDataBarRuleCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

    Constructors

    ConditionalFormatDataBarRuleCollection()

    Initializes a new empty collection.

    Declaration
    public ConditionalFormatDataBarRuleCollection()

    ConditionalFormatDataBarRuleCollection(GridConditionalFormatDescriptor)

    Initialize new instance for ConditionalFormatDataBarRuleCollectionclass.

    Declaration
    public ConditionalFormatDataBarRuleCollection(GridConditionalFormatDescriptor gridConditionalFormatDescriptor)
    Parameters
    Type Name Description
    GridConditionalFormatDescriptor gridConditionalFormatDescriptor

    The GridConditionalFormatDescriptor

    Properties

    Count

    Gets the number of elements contained in the collection.

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

    InsideCollectionEditor

    Gets / sets whether the collection is manipulated inside a collection editor.

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

    IsFixedSize

    Returns False since this collection has no fixed size.

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

    IsReadOnly

    Returns False.

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

    IsSynchronized

    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 ConditionalFormatDataBarRule this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type Description
    ConditionalFormatDataBarRule

    Version

    The version number of this collection. The version is increased each time the collection or an element within the collection was modified.

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

    Methods

    Add(ConditionalFormatDataBarRule)

    Adds a filter descriptor to the end of the collection.

    Declaration
    public int Add(ConditionalFormatDataBarRule value)
    Parameters
    Type Name Description
    ConditionalFormatDataBarRule value

    The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based collection index at which the value has been added.

    Clear()

    Removes all elements from the collection.

    Declaration
    public void Clear()

    Clone()

    Creates a copy of the collection and all its elements.

    Declaration
    public ConditionalFormatDataBarRuleCollection Clone()
    Returns
    Type Description
    ConditionalFormatDataBarRuleCollection

    A copy of the collection and all its elements.

    Contains(ConditionalFormatDataBarRule)

    Determines if the element belongs to this collection.

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

    The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Boolean

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

    CopyTo(ConditionalFormatDataBarRule[], Int32)

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

    Declaration
    public void CopyTo(ConditionalFormatDataBarRule[] array, int index)
    Parameters
    Type Name Description
    ConditionalFormatDataBarRule[] 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 of the object and collection items.

    Declaration
    public void Dispose()

    Equals(Object)

    Determines whether the specified System.Object is equal to the current System.Object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The System.Object to compare with the current System.Object.

    Returns
    Type Description
    System.Boolean

    true if the specified System.Object is equal to the current System.Object; otherwise, false.

    Overrides
    System.Object.Equals(System.Object)

    GetEnumerator()

    Returns an enumerator for the entire collection.

    Declaration
    public ConditionalFormatDataBarRuleCollectionEnumerator GetEnumerator()
    Returns
    Type Description
    ConditionalFormatDataBarRuleCollectionEnumerator

    An Enumerator for the entire collection.

    Remarks

    Enumerators only allow reading of the data in the collection. Enumerators cannot be used to modify the underlying collection.

    GetHashCode()

    Serves as a hash function for a particular type.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

    A hash code for the current object.

    Overrides
    System.Object.GetHashCode()

    IndexOf(ConditionalFormatDataBarRule)

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

    Declaration
    public int IndexOf(ConditionalFormatDataBarRule value)
    Parameters
    Type Name Description
    ConditionalFormatDataBarRule 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.

    InitializeFrom(ConditionalFormatDataBarRuleCollection)

    Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

    Declaration
    public void InitializeFrom(ConditionalFormatDataBarRuleCollection other)
    Parameters
    Type Name Description
    ConditionalFormatDataBarRuleCollection other

    The source collection.

    Insert(Int32, ConditionalFormatDataBarRule)

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

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

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

    ConditionalFormatDataBarRule value

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

    OnChanged(ListPropertyChangedEventArgs)

    Raises the Changed event.

    Declaration
    protected virtual void OnChanged(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    A ListPropertyChangedEventArgs that contains the event data.

    OnChanging(ListPropertyChangedEventArgs)

    Raises the Changing event.

    Declaration
    protected virtual void OnChanging(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    A ListPropertyChangedEventArgs that contains the event data.

    OnPropertyChanged(DescriptorPropertyChangedEventArgs)

    Raises the PropertyChanged event.

    Declaration
    protected virtual void OnPropertyChanged(DescriptorPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    DescriptorPropertyChangedEventArgs e

    A DescriptorPropertyChangedEventArgs that contains the event data.

    OnPropertyChanging(DescriptorPropertyChangedEventArgs)

    Raises the PropertyChanging event.

    Declaration
    protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    DescriptorPropertyChangedEventArgs e

    A DescriptorPropertyChangedEventArgs that contains the event data.

    Remove(ConditionalFormatDataBarRule)

    Removes the specified descriptor element from the collection.

    Declaration
    public void Remove(ConditionalFormatDataBarRule value)
    Parameters
    Type Name Description
    ConditionalFormatDataBarRule 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.

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    A string that represents the current object.

    Overrides
    System.Object.ToString()

    Events

    Changed

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

    Declaration
    public event ListPropertyChangedEventHandler Changed
    Event Type
    Type Description
    ListPropertyChangedEventHandler

    Changing

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

    Declaration
    public event ListPropertyChangedEventHandler Changing
    Event Type
    Type Description
    ListPropertyChangedEventHandler

    PropertyChanged

    Occurs when a property is changed.

    Declaration
    public event DescriptorPropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    DescriptorPropertyChangedEventHandler

    PropertyChanging

    Occurs before a property is changed.

    Declaration
    public event DescriptorPropertyChangedEventHandler PropertyChanging
    Event Type
    Type Description
    DescriptorPropertyChangedEventHandler

    Explicit Interface Implementations

    IInsideCollectionEditorProperty.InitializeFrom(Object)

    Declaration
    void IInsideCollectionEditorProperty.InitializeFrom(object other)
    Parameters
    Type Name Description
    System.Object other

    ICollection.CopyTo(Array, Int32)

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

    Declaration
    void ICollection.CopyTo(Array array, int index)
    Parameters
    Type Name Description
    System.Array 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.

    ICollection.SyncRoot

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

    IEnumerable.GetEnumerator()

    Returns an enumerator for the entire collection.

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

    An Enumerator for the entire collection.

    Remarks

    Enumerators only allow reading of the data in the collection. Enumerators cannot be used to modify the underlying collection.

    IList.Add(Object)

    Adds a filter descriptor to the end of the collection.

    Declaration
    int IList.Add(object value)
    Parameters
    Type Name Description
    System.Object value

    The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based collection index at which the value has been added.

    IList.Contains(Object)

    Determines if the element belongs to this collection.

    Declaration
    bool IList.Contains(object value)
    Parameters
    Type Name Description
    System.Object value

    The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Boolean

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

    IList.get_Item(Int32)

    Declaration
    object IList.get_Item(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type Description
    System.Object

    IList.IndexOf(Object)

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

    Declaration
    int IList.IndexOf(object value)
    Parameters
    Type Name Description
    System.Object 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.

    IList.Insert(Int32, Object)

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

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

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

    System.Object value

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

    IList.Item[Int32]

    Declaration
    object IList.this[] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type Description
    System.Object

    IList.Remove(Object)

    Removes the specified descriptor element from the collection.

    Declaration
    void IList.Remove(object value)
    Parameters
    Type Name Description
    System.Object 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.

    IList.set_Item(Int32, Object)

    Declaration
    void IList.set_Item(int index, object value)
    Parameters
    Type Name Description
    System.Int32 index
    System.Object value

    ICloneable.Clone()

    Declaration
    object ICloneable.Clone()
    Returns
    Type Description
    System.Object

    Implements

    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved