WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridRelationDescriptorCollection - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridRelationDescriptorCollection

    Represents a collection of GridRelationDescriptor elements with constraints for a relation between two tables and schema information of child tables. An instance of this collection is returned by the Relations property of a GridTableDescriptor.

    Inheritance
    System.Object
    GridRelationDescriptorCollection
    Implements
    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Inherited Members
    System.Object.ToString()
    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 GridRelationDescriptorCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

    Constructors

    GridRelationDescriptorCollection()

    Initializes a new instances of the GridRelationDescriptorCollection class.

    Declaration
    public GridRelationDescriptorCollection()

    Properties

    Count

    Gets the number of elements contained in the collection. The property also ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

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

    Inner

    Gets the inner value of RelationDescriptorCollection

    Declaration
    public RelationDescriptorCollection Inner { get; }
    Property Value
    Type Description
    RelationDescriptorCollection

    InsideCollectionEditor

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

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

    IsFixedSize

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

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

    IsReadOnly

    Gets the value whether the collection is Read-only or not.

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

    IsSynchronized

    Gets the value whether this collection has synchronized or not.

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

    Returns False.

    Item[Int32]

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

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

    Item[String]

    Gets or sets the element with the specified name.

    Declaration
    public GridRelationDescriptor this[string name] { get; set; }
    Parameters
    Type Name Description
    System.String name
    Property Value
    Type Description
    GridRelationDescriptor

    NestedCount

    Gets the nested count. Used internally.

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

    ShouldPopulate

    Gets or sets whether collection should check for changes in engine schema or underlying data source schema when EnsureInitialized gets called.

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

    Methods

    Add(GridRelationDescriptor)

    Adds an object to the end of the collection.

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

    AddRange(GridRelationDescriptor[])

    Adds multiple elements at the end of the collection.

    Declaration
    public void AddRange(GridRelationDescriptor[] values)
    Parameters
    Type Name Description
    GridRelationDescriptor[] values

    The array whose elements should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic).

    Clear()

    Removes all elements from the collection.

    Declaration
    public void Clear()

    Clone()

    Creates a copy of the collection and all its elements.

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

    A copy of the collection and all its elements.

    Contains(GridRelationDescriptor)

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

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

    The Object 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.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    CopyTo(Array, Int32)

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

    Declaration
    public void 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.

    Dispose()

    Disposes of the object and collection items.

    Declaration
    public void Dispose()

    EnableOneTimePopulate()

    When called the ShouldPopulate property will be set true temporarily until the next EnsureInitialized call and then be reset again to optimize subsequent lookups. The Engine calls this method when schema changes occurred (PropertyChanged was raised).

    Declaration
    public void EnableOneTimePopulate()

    Equals(Object)

    Determines a value 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.

    Overrides
    System.Object.Equals(System.Object)

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

    Overrides
    System.Object.GetHashCode()

    IndexOf(GridRelationDescriptor)

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

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

    Copies settings from another collection.

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

    The source collection.

    InitializeFrom(GridRelationDescriptorCollection)

    Copies settings from another collection.

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

    The source collection.

    Insert(Int32, GridRelationDescriptor)

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

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

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

    GridRelationDescriptor value

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

    LoadDefault()

    Resets the collection to its default state, auto populates it, and marks it as modified. Call this method if you want to load the default items for the collection and then modify it (e.g. remove members from the auto-populated list).

    Declaration
    public void LoadDefault()

    Remove(GridRelationDescriptor)

    Removes the specified descriptor element from the collection.

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

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

    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.

    Reset()

    Resets the collection to its default state. If the collection is bound to a GridTableDescriptor, the collection will auto populate itself the next time an item inside the collection is accessed.

    Declaration
    public void Reset()

    Explicit Interface Implementations

    IInsideCollectionEditorProperty.InitializeFrom(Object)

    Initializes the form for GridRelationDescriptorCollection.

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

    Collection of GridRelationDescriptor.

    ICollection.SyncRoot

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

    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.set_Item(Int32, Object)

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

    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