WinForms

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

    Show / Hide Table of Contents

    Class RelationChildColumnDescriptorCollection

    A collection from RelationChildColumnDescriptor that are children of a TableDescriptor. A RelationChildColumnDescriptor defines the sort order of a related table which is defined by the child columns in a a master details relation.

    An instance of this collection is returned by the RelationChildColumns property of a TableDescriptor.

    Inheritance
    System.Object
    SortColumnDescriptorCollection
    RelationChildColumnDescriptorCollection
    Implements
    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Inherited Members
    SortColumnDescriptorCollection.EnableOneTimePopulate()
    SortColumnDescriptorCollection.Reset()
    SortColumnDescriptorCollection.LoadDefault()
    SortColumnDescriptorCollection.ToString()
    SortColumnDescriptorCollection.ToArray()
    SortColumnDescriptorCollection.IInsideCollectionEditorProperty.InitializeFrom(Object)
    SortColumnDescriptorCollection.InitializeFrom(SortColumnDescriptorCollection)
    SortColumnDescriptorCollection.InitializeFrom(SortColumnDescriptorCollection, Boolean)
    SortColumnDescriptorCollection.AddRange(SortColumnDescriptor[])
    SortColumnDescriptorCollection.CopyAllMembersTo(SortColumnDescriptorCollection)
    SortColumnDescriptorCollection.BumpVersion()
    SortColumnDescriptorCollection.Contains(SortColumnDescriptor)
    SortColumnDescriptorCollection.Contains(String)
    SortColumnDescriptorCollection.IndexOf(SortColumnDescriptor)
    SortColumnDescriptorCollection.IndexOf(String)
    SortColumnDescriptorCollection.CopyTo(SortColumnDescriptor[], Int32)
    SortColumnDescriptorCollection.Insert(Int32, SortColumnDescriptor)
    SortColumnDescriptorCollection.Remove(SortColumnDescriptor)
    SortColumnDescriptorCollection.Add(SortColumnDescriptor)
    SortColumnDescriptorCollection.Add(String)
    SortColumnDescriptorCollection.Add(String, ListSortDirection)
    SortColumnDescriptorCollection.Remove(String)
    SortColumnDescriptorCollection.RemoveAt(Int32)
    SortColumnDescriptorCollection.Dispose()
    SortColumnDescriptorCollection.Clear()
    SortColumnDescriptorCollection.OnChanged(ListPropertyChangedEventArgs)
    SortColumnDescriptorCollection.OnChanging(ListPropertyChangedEventArgs)
    SortColumnDescriptorCollection.ICloneable.Clone()
    SortColumnDescriptorCollection.IList.get_Item(Int32)
    SortColumnDescriptorCollection.IList.set_Item(Int32, Object)
    SortColumnDescriptorCollection.IList.Insert(Int32, Object)
    SortColumnDescriptorCollection.IList.Remove(Object)
    SortColumnDescriptorCollection.IList.Contains(Object)
    SortColumnDescriptorCollection.IList.IndexOf(Object)
    SortColumnDescriptorCollection.IList.Add(Object)
    SortColumnDescriptorCollection.ICollection.CopyTo(Array, Int32)
    SortColumnDescriptorCollection.IEnumerable.GetEnumerator()
    SortColumnDescriptorCollection.ShouldPopulate
    SortColumnDescriptorCollection.IsModified
    SortColumnDescriptorCollection.InsideCollectionEditor
    SortColumnDescriptorCollection.Version
    SortColumnDescriptorCollection.IsReadOnly
    SortColumnDescriptorCollection.IsFixedSize
    SortColumnDescriptorCollection.IsSynchronized
    SortColumnDescriptorCollection.Count
    SortColumnDescriptorCollection.IList.Item[Int32]
    SortColumnDescriptorCollection.ICollection.SyncRoot
    SortColumnDescriptorCollection.Changed
    SortColumnDescriptorCollection.Changing
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Grouping
    Assembly: Syncfusion.Grouping.Base.dll
    Syntax
    public class RelationChildColumnDescriptorCollection : SortColumnDescriptorCollection, IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

    Fields

    Empty

    A Read-only and empty collection.

    Declaration
    public static readonly RelationChildColumnDescriptorCollection Empty
    Field Value
    Type Description
    RelationChildColumnDescriptorCollection

    Properties

    Item[Int32]

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

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

    Item[String]

    Gets or sets the element with the specified name.

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

    Methods

    Add(String, String)

    Adds a RelationChildColumnDescriptor to the end of the collection.

    Declaration
    public int Add(string parentColumnName, string childColumnName)
    Parameters
    Type Name Description
    System.String parentColumnName

    The name of the index field in the parent table.

    System.String childColumnName

    The name of the index field in the child table.

    Returns
    Type Description
    System.Int32

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

    AddRange(RelationChildColumnDescriptor[])

    Adds multiple elements at the end of the collection.

    Declaration
    public void AddRange(RelationChildColumnDescriptor[] columnDescriptors)
    Parameters
    Type Name Description
    RelationChildColumnDescriptor[] columnDescriptors

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

    CheckOutOfDate()

    Called internally to ensure all field descriptors are up to date after table descriptor is changed.

    Declaration
    protected override bool CheckOutOfDate()
    Returns
    Type Description
    System.Boolean

    True if field descriptors need to be reinitialized

    Overrides
    SortColumnDescriptorCollection.CheckOutOfDate()

    CheckType(Object)

    Checks the type of object.

    Declaration
    protected override void CheckType(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The Object.

    Overrides
    SortColumnDescriptorCollection.CheckType(Object)

    Clone()

    Creates a copy of the collection and all its elements.

    Declaration
    public RelationChildColumnDescriptorCollection Clone()
    Returns
    Type Description
    RelationChildColumnDescriptorCollection

    A copy of the collection and all its elements.

    Equals(Object)

    Determines if the specified object is equivalent to the current object.

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

    An object to compare.

    Returns
    Type Description
    System.Boolean

    True if both objects are equal; False otherwise.

    Overrides
    SortColumnDescriptorCollection.Equals(Object)

    GetEnumerator()

    Returns an enumerator for the entire collection.

    Declaration
    public RelationChildColumnDescriptorCollectionEnumerator GetEnumerator()
    Returns
    Type Description
    RelationChildColumnDescriptorCollectionEnumerator

    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.

    GetHashCode()

    Serves as a hash function.

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

    Hash code.

    Overrides
    SortColumnDescriptorCollection.GetHashCode()

    InitializeFrom(RelationKeyDescriptorCollection)

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

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

    The source collection.

    InitializeFrom(RelationKeyDescriptorCollection, Boolean)

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

    Declaration
    public bool InitializeFrom(RelationKeyDescriptorCollection other, bool raiseChangeEvents)
    Parameters
    Type Name Description
    RelationKeyDescriptorCollection other

    The source collection.

    System.Boolean raiseChangeEvents

    Specifies if Changing and Changed events should be raised.

    Returns
    Type Description
    System.Boolean

    True if the operation is successfully completed.

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