WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ConditionalFormatRuleBaseCollection - WindowsForms API Reference | Syncfusion ConditionalFormatRuleBase objects. ">

    Show / Hide Table of Contents

    Class ConditionalFormatRuleBaseCollection

    A collection contains ConditionalFormatRuleBase objects.

    Inheritance
    System.Object
    ConditionalFormatRuleBaseCollection
    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 ConditionalFormatRuleBaseCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

    Constructors

    ConditionalFormatRuleBaseCollection()

    Initializes a new empty collection.

    Declaration
    public ConditionalFormatRuleBaseCollection()

    ConditionalFormatRuleBaseCollection(ConditionalFormatRuleBase[])

    Initialize new instance ConditionalFormatRuleBaseCollection class.

    Declaration
    public ConditionalFormatRuleBaseCollection(ConditionalFormatRuleBase[] rulebase)
    Parameters
    Type Name Description
    ConditionalFormatRuleBase[] rulebase

    The array of ConditionalFormatRuleBase objects.

    ConditionalFormatRuleBaseCollection(GridConditionalFormatDescriptor)

    Initialize new instance ConditionalFormatRuleBaseCollection class.

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

    The GridConditionalFormatDescriptor contains properties and methods.

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

    SyncRoot

    Gets System.NotImplementedException

    Declaration
    public ConditionalFormatRuleBase SyncRoot { get; }
    Property Value
    Type Description
    ConditionalFormatRuleBase

    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(ConditionalFormatRuleBase)

    Adds a filter descriptor to the end of the collection.

    Declaration
    public int Add(ConditionalFormatRuleBase value)
    Parameters
    Type Name Description
    ConditionalFormatRuleBase 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 ConditionalFormatRuleBaseCollection Clone()
    Returns
    Type Description
    ConditionalFormatRuleBaseCollection

    A copy of the collection and all its elements.

    Contains(ConditionalFormatRuleBase)

    Determines if the element with the specified name belongs to this collection.

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

    The name of the element to locate in the collection.

    Returns
    Type Description
    System.Boolean

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

    CopyTo(ConditionalFormatRuleBase[], Int32)

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

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

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

    System.Int32 index

    The zero-based index in 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)

    GetAttributes()

    Returns a collection of attributes for the specified component and a Boolean indicating that a custom type descriptor has been created.

    Declaration
    public AttributeCollection GetAttributes()
    Returns
    Type Description
    System.ComponentModel.AttributeCollection

    Returns the attributeCollecion.

    GetClassName()

    Returns the name of the class for the specified component using a custom type descriptor.

    Declaration
    public string GetClassName()
    Returns
    Type Description
    System.String

    Returns the string .

    GetComponentName()

    Returns the name of the specified component using a custom type descriptor.

    Declaration
    public string GetComponentName()
    Returns
    Type Description
    System.String

    Returns the string componet name

    GetConverter()

    Returns a type converter for the type of the specified component with a custom type descriptor.

    Declaration
    public TypeConverter GetConverter()
    Returns
    Type Description
    System.ComponentModel.TypeConverter

    A System.ComponentModel.TypeConverter for the specified component.

    GetDefaultEvent()

    Returns the default event for a component with a custom type descriptor.

    Declaration
    public EventDescriptor GetDefaultEvent()
    Returns
    Type Description
    System.ComponentModel.EventDescriptor

    An System.ComponentModel.EventDescriptor with the default event, or null if there are no events.

    GetDefaultProperty()

    Returns the default property for the specified component with a custom type descriptor.

    Declaration
    public PropertyDescriptor GetDefaultProperty()
    Returns
    Type Description
    System.ComponentModel.PropertyDescriptor

    A System.ComponentModel.PropertyDescriptor with the default property, or null if there are no properties.

    GetEditor(Type)

    Returns an editor with the specified base type and with a custom type descriptor for the specified component.

    Declaration
    public object GetEditor(Type editorBaseType)
    Parameters
    Type Name Description
    System.Type editorBaseType

    A System.Type that represents the base type of the editor you want to find.

    Returns
    Type Description
    System.Object

    An instance of the editor that can be cast to the specified editor type,or null if no editor of the requested type can be found.

    GetEnumerator()

    Returns an enumerator for the entire collection.

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

    An Enumerator for the entire collection.

    Remarks

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

    GetEvents()

    Returns the collection of events for a specified component with a custom type descriptor.

    Declaration
    public EventDescriptorCollection GetEvents()
    Returns
    Type Description
    System.ComponentModel.EventDescriptorCollection

    An System.ComponentModel.EventDescriptorCollection with the events for this component.

    GetEvents(Attribute[])

    Returns the collection of events for a specified component using a specified array of attributes as a filter and using a custom type descriptor.

    Declaration
    public EventDescriptorCollection GetEvents(Attribute[] attributes)
    Parameters
    Type Name Description
    System.Attribute[] attributes

    An array of type System.Attribute to use as a filter.

    Returns
    Type Description
    System.ComponentModel.EventDescriptorCollection

    An System.ComponentModel.EventDescriptorCollection with the events that match the specified attributes for this component.

    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()

    GetProperties()

    Returns the properties for this instance of a component.

    Declaration
    public PropertyDescriptorCollection GetProperties()
    Returns
    Type Description
    System.ComponentModel.PropertyDescriptorCollection

    A System.ComponentModel.PropertyDescriptorCollection that represents the filtered properties for this component instance.

    GetProperties(Attribute[])

    Returns the properties for this instance of a component using the attribute array as a filter.

    Declaration
    public PropertyDescriptorCollection GetProperties(Attribute[] attributes)
    Parameters
    Type Name Description
    System.Attribute[] attributes

    An array of type System.Attribute that is used as a filter.

    Returns
    Type Description
    System.ComponentModel.PropertyDescriptorCollection

    A System.ComponentModel.PropertyDescriptorCollection that represents the filtered properties for this component instance.

    GetPropertyOwner(PropertyDescriptor)

    Returns an object that contains the property described by the specified property descriptor.

    Declaration
    public object GetPropertyOwner(PropertyDescriptor pd)
    Parameters
    Type Name Description
    System.ComponentModel.PropertyDescriptor pd

    A System.ComponentModel.PropertyDescriptor that represents the property whose owner is to be found.

    Returns
    Type Description
    System.Object

    An System.Object that represents the owner of the specified property.

    IndexOf(ConditionalFormatRuleBase)

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

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

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

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

    The source collection.

    Insert(Int32, ConditionalFormatRuleBase)

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

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

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

    ConditionalFormatRuleBase 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.

    Remove(ConditionalFormatRuleBase)

    Removes the specified descriptor element from the collection.

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

    Remove(String)

    Removes the specified descriptor element with the specified name from the collection.

    Declaration
    public void Remove(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to remove from the collection.If no element with that name is found 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

    String representation of the 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

    Explicit Interface Implementations

    IInsideCollectionEditorProperty.InitializeFrom(Object)

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

    ICollection.CopyTo(Array, Int32)

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

    ICollection.Count

    Declaration
    int ICollection.Count { get; }
    Returns
    Type Description
    System.Int32

    ICollection.IsSynchronized

    Declaration
    bool ICollection.IsSynchronized { get; }
    Returns
    Type Description
    System.Boolean

    ICollection.SyncRoot

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

    IEnumerable.GetEnumerator()

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

    IList.Add(Object)

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

    IList.Contains(Object)

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

    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)

    Declaration
    int IList.IndexOf(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    System.Int32

    IList.Insert(Int32, Object)

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

    IList.Item[Int32]

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

    IList.Remove(Object)

    Declaration
    void IList.Remove(object value)
    Parameters
    Type Name Description
    System.Object value

    IList.RemoveAt(Int32)

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

    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 - 2022 Syncfusion Inc. All Rights Reserved