Class GridConditionalFormatDescriptorCollection

Represents a collection of GridConditionalFormatDescriptor which provide filter criteria for displaying a subset of records from the underlying data source with conditional cell formatting.

An instance of this collection is returned by the ConditionalFormats property of a GridTableDescriptor.

Inheritance

System.Object

GridConditionalFormatDescriptorCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GridConditionalFormatDescriptorCollection : Object, IDisposable, IList, ICollection, IEnumerable, ICloneable, ICustomTypeDescriptor

Constructors

GridConditionalFormatDescriptorCollection()

Initializes a new instances of the GridConditionalFormatDescriptorCollection class.

Declaration

public GridConditionalFormatDescriptorCollection()

Properties

Count

Gets the number of elements contained in the collection.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

InsideCollectionEditor

Gets or sets a value indicating whether the collection is manipulated inside a collection editor or not.

Declaration

public bool InsideCollectionEditor { get; set; }

Property Value

Type
System.Boolean

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 GridConditionalFormatDescriptor this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
GridConditionalFormatDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

public GridConditionalFormatDescriptor this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type
GridConditionalFormatDescriptor

Version

Gets 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
System.Int32

Methods

Add(GridConditionalFormatDescriptor)

Adds a filter descriptor to the end of the collection.

Declaration

public int Add(GridConditionalFormatDescriptor value)

Parameters

Type	Name	Description
GridConditionalFormatDescriptor	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.

add_Changed(ListPropertyChangedEventHandler)

Declaration

public void add_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

add_Changing(ListPropertyChangedEventHandler)

Declaration

public void add_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

add_PropertyChanged(DescriptorPropertyChangedEventHandler)

Declaration

public void add_PropertyChanged(DescriptorPropertyChangedEventHandler value)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventHandler	value

add_PropertyChanging(DescriptorPropertyChangedEventHandler)

Declaration

public void add_PropertyChanging(DescriptorPropertyChangedEventHandler value)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventHandler	value

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public GridConditionalFormatDescriptorCollection Clone()

Returns

Type	Description
GridConditionalFormatDescriptorCollection	A copy of the collection and all its elements.

Contains(GridConditionalFormatDescriptor)

Determines a value indicating whether the element belongs to this collection or not.

Declaration

public bool Contains(GridConditionalFormatDescriptor value)

Parameters

Type	Name	Description
GridConditionalFormatDescriptor	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.

Contains(String)

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

Declaration

public bool Contains(string name)

Parameters

Type	Name	Description
System.String	name	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(GridConditionalFormatDescriptor[], Int32)

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

Declaration

public void CopyTo(GridConditionalFormatDescriptor[] array, int index)

Parameters

Type	Name	Description
GridConditionalFormatDescriptor[]	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 a value indicating whether the specified System.Object is equal to the current System.Object or not.

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.

GetEnumerator()

Gets an enumerator for the entire collection.

Declaration

public GridConditionalFormatDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
GridConditionalFormatDescriptorCollectionEnumerator	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()

Gets a hash function for a particular type.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current object.

IndexOf(GridConditionalFormatDescriptor)

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

Declaration

public int IndexOf(GridConditionalFormatDescriptor value)

Parameters

Type	Name	Description
GridConditionalFormatDescriptor	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.

IndexOf(String)

Searches for the element with the specified name.

Declaration

public int IndexOf(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

Type	Description
System.Int32	The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.

InitializeFrom(GridConditionalFormatDescriptorCollection)

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

Declaration

public void InitializeFrom(GridConditionalFormatDescriptorCollection other)

Parameters

Type	Name	Description
GridConditionalFormatDescriptorCollection	other	The source collection.

Insert(Int32, GridConditionalFormatDescriptor)

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

Declaration

public void Insert(int index, GridConditionalFormatDescriptor value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
GridConditionalFormatDescriptor	value	The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

OnChanged(ListPropertyChangedEventArgs)

Triggered when the Changed event is done.

Declaration

protected virtual void OnChanged(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs contains the event data.

OnChanging(ListPropertyChangedEventArgs)

Triggered when the Changing event is done.

Declaration

protected virtual void OnChanging(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs contains the event data.

OnPropertyChanged(DescriptorPropertyChangedEventArgs)

Triggers when the PropertyChanged event is done.

Declaration

protected virtual void OnPropertyChanged(DescriptorPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventArgs	e	A DescriptorPropertyChangedEventArgs contains the event data.

OnPropertyChanging(DescriptorPropertyChangedEventArgs)

Triggered when the PropertyChanging event is done.

Declaration

protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventArgs	e	A DescriptorPropertyChangedEventArgs contains the event data.

Remove(GridConditionalFormatDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(GridConditionalFormatDescriptor value)

Parameters

Type	Name	Description
GridConditionalFormatDescriptor	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.

remove_Changed(ListPropertyChangedEventHandler)

Declaration

public void remove_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

remove_Changing(ListPropertyChangedEventHandler)

Declaration

public void remove_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

remove_PropertyChanged(DescriptorPropertyChangedEventHandler)

Declaration

public void remove_PropertyChanged(DescriptorPropertyChangedEventHandler value)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventHandler	value

remove_PropertyChanging(DescriptorPropertyChangedEventHandler)

Declaration

public void remove_PropertyChanging(DescriptorPropertyChangedEventHandler value)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventHandler	value

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

Overrides and gets the string representation of the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current object.

Events

Changed

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

Declaration

public event ListPropertyChangedEventHandler Changed

Event Type

Type
ListPropertyChangedEventHandler

Changing

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

Declaration

public event ListPropertyChangedEventHandler Changing

Event Type

Type
ListPropertyChangedEventHandler

PropertyChanged

Occurs when a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanged

Event Type

Type
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanging

Event Type

Type
DescriptorPropertyChangedEventHandler

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor