menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TableDescriptor - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TableDescriptor

    Represents the class that maintains schema information for a table. Collections define fields, expressions, sorted, grouped columns, and related tables.

    Inheritance
    System.Object
    ShouldSerializeBasedPersisterType
    DescriptorBase
    SourceListDescriptor
    TableDescriptor
    GridTableDescriptor
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IItemPropertiesSource
    System.ComponentModel.ITypedList
    ITableEventsTarget
    Inherited Members
    DescriptorBase.CanResetValue()
    DescriptorBase.Dispose()
    DescriptorBase.Disposed
    DescriptorBase.Disposing
    DescriptorBase.InDisposed
    DescriptorBase.IsDisposed
    DescriptorBase.OnDisposed(EventArgs)
    DescriptorBase.ShouldSerialize()
    ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)
    ShouldSerializeBasedPersisterType.CheckAllProperties
    ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)
    ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)
    SourceListDescriptor.GetName()
    SourceListDescriptor.IgnoreSetItemProperties
    SourceListDescriptor.IItemPropertiesSource.GetItemProperties()
    SourceListDescriptor.InitializeItemProperties
    SourceListDescriptor.ItemPropertiesChanged
    SourceListDescriptor.ItemPropertiesChanging
    SourceListDescriptor.ItemPropertiesVersion
    SourceListDescriptor.ListChanged
    SourceListDescriptor.ListChanging
    SourceListDescriptor.NameChanged
    SourceListDescriptor.NameChanging
    SourceListDescriptor.OnListChanged(ListChangedEventArgs)
    SourceListDescriptor.OnListChanging(ListChangedEventArgs)
    SourceListDescriptor.Reset()
    SourceListDescriptor.ResetItemProperties()
    SourceListDescriptor.ResetName()
    SourceListDescriptor.SetItemProperties(Object)
    SourceListDescriptor.SetItemProperties(PropertyDescriptorCollection)
    SourceListDescriptor.SetItemProperties(Type)
    SourceListDescriptor.ShouldSerializeItemProperties()
    SourceListDescriptor.SourceListSet
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.Grouping
    Assembly: Syncfusion.Grouping.Base.dll
    Syntax
    public class TableDescriptor : SourceListDescriptor, ICustomTypeDescriptor, IDisposable, IItemPropertiesSource, ITypedList, ITableEventsTarget
    Remarks

    TableDescriptor has several collections that can either be auto-populated from the underlying datasource or manually modified.

    CollectionDescriptions
    Fields The Fields collection is auto-populated from the underlying sourcelist's columns. Normally you will not modify this collection and just use it in its default auto-populated state. A fieldDescriptor holds a name, mapping name, and type of the column in the list.
    Relations The Relations collection is auto-populated from the underlying sourcelist's relations. It will extract its information from an ADO.NET datasource. If you have other IList collections that are related, you can add RelationDescriptor manually to this collection and specify the primary and foreign key between the two lists.
    ExpressionFields The ExpressionFields collection has ExpressionFields. You need to manually add ExpressionFields. This collection is not auto-populated from the datasource. A fieldDescriptor holds a name and the formula expression of the column.
    GroupedColumns The GroupedColumns collections contains SortColumnDescriptor objects. It defines the grouping of the table. Each SortColumnDescriptor has a name that identifies a field in the Fields or ExpressionFields collection, a SortDirection property, and a FieldDescriptor property. The FieldDescriptor is Read-only and looked up in the Fields or ExpressionFields collection using the Name of the SortColumnDescriptor. A custom categorizer can be specified that allows you to group records into ranges of data, e.g. if you want to group by month.
    Sortedcolumns The Sortedcolumns collection contains SortColumnDescriptor objects. It specifies the sort order of records within a group.
    RecordFilters The RecordFilters collection has RecordFilterDescriptor objects. RecordFilters define selection criteria to hide or show records based on criteria.
    Summaries The Summaries collection holds SummaryDescriptors. A SummaryDescriptor has a name, a mapping name that identifies the field (Fields or ExpressionFields collection) for which summaries should be calculated for, and a SummaryType property that defines the type of calculations to be performed. Possible SummaryTypes are: Count, BooleanAggregate, ByteAggregate, CharAggregate, DistinctCount, DoubleAggregate, Int32Aggregate, MaxLength, StringAggregate, Vector, DoubleVector, and Custom. When you specify the SummaryType.Custom type, you need to set the custom method through the CreateSummaryMethod property of the SummaryDescriptor. It is of type CreateSummaryDelegate and is called to create a instance of a summary object.

    The Field and Relations collections feature auto-population on demand and reflect changes from the collection they depend on. The auto-population will happen when you access the contents of the collection, e.g. if you query its Count.

    GroupedColumns and SortedColumns need to be manually initialized. They are not auto-populated.

    SortedColumnDescriptor also lets you specify a custom comparer that implements the IComparer interface.

    Constructors

    TableDescriptor()

    Initializes a new instances of the TableDescriptor class.

    Declaration
    public TableDescriptor()

    TableDescriptor(Engine, RelationDescriptor)

    Initializes a new instances of the TableDescriptor class specified with is a child of a RelationDescriptor.

    Declaration
    public TableDescriptor(Engine engine, RelationDescriptor parentRelation)
    Parameters
    Type Name Description
    Engine engine

    Grouping engine.

    RelationDescriptor parentRelation

    Parent relation.

    TableDescriptor(RelationDescriptor)

    Initializes a new instances of the TableDescriptor class with the specified instance of RelationDescriptor.

    Declaration
    public TableDescriptor(RelationDescriptor parentRelation)
    Parameters
    Type Name Description
    RelationDescriptor parentRelation

    Parent relation.

    Properties

    AllowEdit

    Gets or sets a value indicating whether editing records should be allowed or not to the underlying source list supports editing records.

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

    AllowNew

    Gets or sets a value indicating whether adding new records should be allowed or not to the underlying source list supports adding records.

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

    AllowRemove

    Gets or sets a value indicating whether removing records should be allowed or not to the underlying source list supports removing records.

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

    Engine

    Gets a reference to the Engine object that this table descriptor belongs to.

    Declaration
    public Engine Engine { get; }
    Property Value
    Type
    Engine

    ExpressionFieldEvaluator

    Gets the value of the ExpressionFieldEvaluator for this table which provides methods for parsing and calculating formulas that can reference fields of the Fields collection.

    Declaration
    public ExpressionFieldEvaluator ExpressionFieldEvaluator { get; }
    Property Value
    Type
    ExpressionFieldEvaluator

    ExpressionFields

    Gets or sets the value of the expression fields.

    Declaration
    public ExpressionFieldDescriptorCollection ExpressionFields { get; set; }
    Property Value
    Type
    ExpressionFieldDescriptorCollection
    Remarks

    Gets the collection of ExpressionFieldDescriptor objects defining expression fields that represent values for each row in the table. Expression fields can reference other fields and support arithmetic calculations and boolean expressions.

    Fields

    Gets or sets the value of the collection of TableDescriptor objects defining fields that represent bound or unbound values for each row in the table.

    Declaration
    public FieldDescriptorCollection Fields { get; set; }
    Property Value
    Type
    FieldDescriptorCollection
    Remarks

    The default state of this collection and child objects is auto-populated from property descriptors found in the underlying source list for this table and expression fields that have been defined for this table.

    If you assign a System.Data.DataView or System.Data.DataTable to SetSourceList(IEnumerable), the FieldDescriptorCollection collection is auto-populated from System.Data.DataColumn objects found in the System.Data.DataView. Expression fields will be appended to the collection.

    Bound fields do have a MappingName that identifies a column in the underlying list.

    Unbound field do have an empty MappingName.

    ForceEmptyRelations

    Gets or sets whether the Relations collection should not be auto-populated. When you set this property true Relations will be called. When you set this property false, ResetRelations() will be called.

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

    True, if the Relations property is true; Otherwise False.

    ForwardTableEvents

    Gets or sets an object that handles events raised by the Table object.

    Declaration
    public ITableEventsTarget ForwardTableEvents { get; set; }
    Property Value
    Type
    ITableEventsTarget

    GroupedColumns

    Gets or sets the value of the grouped columns.

    Declaration
    public SortColumnDescriptorCollection GroupedColumns { get; set; }
    Property Value
    Type
    SortColumnDescriptorCollection
    Remarks

    Gets the collection of SortColumnDescriptor objects defining group by state of the table. Each SortColumnDescriptor in the collection references a FieldDescriptor of the Fields collection.

    InOnInitializeItemProperties

    Gets or sets a value indicating whether the SetItemProperties is called from the OnInitializeItemProperties or not.

    Declaration
    public bool InOnInitializeItemProperties { get; }
    Property Value
    Type
    System.Boolean
    Remarks

    Returns True when SetItemProperties is called from within OnInitializeItemProperties. Once SetItemProperties returns, the property will be reset to False.

    IsGrouped

    Gets a value indicating whether the table is grouped or not.

    Declaration
    public bool IsGrouped { get; }
    Property Value
    Type
    System.Boolean
    Remarks

    Determines if table is grouped. Returns True if GroupedColumns are specified or if the table is a child table in a relation and has relation child columns.

    IsSorted

    Gets a value indicating whether the table is sorted or not.

    Declaration
    public bool IsSorted { get; }
    Property Value
    Type
    System.Boolean
    Remarks

    Determines whether table is sorted. Returns True if any SortedColumns or GroupedColumns are specified or if the table is a child table in a relation and has relation child columns.

    ItemProperties

    Gets or sets the System.ComponentModel.PropertyDescriptorCollection with properties for each record in the table.

    Declaration
    public override PropertyDescriptorCollection ItemProperties { get; set; }
    Property Value
    Type
    System.ComponentModel.PropertyDescriptorCollection
    Overrides
    SourceListDescriptor.ItemProperties

    ItemPropertyTypes

    Gets the dynamic datasource only. Returns null for other type sources.

    Declaration
    public Dictionary<string, Type> ItemPropertyTypes { get; }
    Property Value
    Type
    System.Collections.Generic.Dictionary<System.String, System.Type>

    Name

    Gets or sets the name of the table descriptor.

    Declaration
    public override string Name { get; set; }
    Property Value
    Type
    System.String
    Overrides
    SourceListDescriptor.Name

    ParentRelation

    Gets a reference to the parent RelationDescriptor.

    Declaration
    public RelationDescriptor ParentRelation { get; }
    Property Value
    Type
    RelationDescriptor

    ParentTableDescriptor

    Gets a reference to the parent TableDescriptor which has a RelationDescriptor that references this object.

    Declaration
    public TableDescriptor ParentTableDescriptor { get; }
    Property Value
    Type
    TableDescriptor

    PreviewRowsPerRecord

    Gets the value of the preview rows per record.

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

    Returns 0.

    Remarks

    Called to get the number of preview rows that should be added to each record. Preview rows are the rows that are visible when a record is collapsed.

    PrimaryKeyColumns

    Gets or sets the value of the primary key column.

    Declaration
    public virtual SortColumnDescriptorCollection PrimaryKeyColumns { get; set; }
    Property Value
    Type
    SortColumnDescriptorCollection
    Remarks

    Gets the collection of SortColumnDescriptor objects defining the primary key(s) for records of the table. Each SortColumnDescriptor in the collection references a FieldDescriptor of the Fields collection.

    RecordFilters

    Gets or sets the value of the record filters collection.

    Declaration
    public RecordFilterDescriptorCollection RecordFilters { get; set; }
    Property Value
    Type
    RecordFilterDescriptorCollection
    Remarks

    Gets the collection of RecordFilterDescriptor objects defining filter criteria for records in the table. Each RecordFilterDescriptor in the collection references one or multiple FieldDescriptor of the Fields collection. Multiple criteria can be combined with logical "And" or "Or" operations.

    RelationChildColumns

    Gets the value of the relation child columns.

    Declaration
    public RelationChildColumnDescriptorCollection RelationChildColumns { get; }
    Property Value
    Type
    RelationChildColumnDescriptorCollection
    Remarks

    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.

    Relations

    Gets the collection of RelationDescriptor objects defining relations to other tables.

    Declaration
    public RelationDescriptorCollection Relations { get; }
    Property Value
    Type
    RelationDescriptorCollection
    Remarks

    The default state of this collection and child objects is auto-populated from relation descriptors found in the underlying source list for this table.

    If you assign a System.Data.DataView or System.Data.DataSet to SetSourceList(IEnumerable), the Relations collection is auto-populated from System.Data.DataRelation objects found in the System.Data.DataSet.

    RowsPerRecord

    Gets the value of rows per record.

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

    Returns 1.

    Remarks

    Called to get the number of rows that should be added to each record. These are the rows that are visible when a record is expanded.

    SortedColumns

    Gets or sets the value of the sorted columns.

    Declaration
    public SortColumnDescriptorCollection SortedColumns { get; set; }
    Property Value
    Type
    SortColumnDescriptorCollection
    Remarks

    Gets the collection of SortColumnDescriptor objects defining sort state of the table. Each SortColumnDescriptor in the collection references a FieldDescriptor of the Fields collection. Multiple columns can be specified for sorting with the first column having the highest sort precedence.

    Summaries

    Gets or sets the value of the summary descriptors.

    Declaration
    public SummaryDescriptorCollection Summaries { get; set; }
    Property Value
    Type
    SummaryDescriptorCollection
    Remarks

    Gets the collection of SummaryDescriptor objects defining summaries of the table. Each SummaryDescriptor in the collection references a FieldDescriptor of the Fields collection. Based on the summaries defined in this collection each group in the table will have summaries calculated.

    UnboundFields

    Gets or set the values of the collection of FieldDescriptor objects defining unbound fields that are filled by the user.

    Declaration
    public UnboundFieldDescriptorCollection UnboundFields { get; set; }
    Property Value
    Type
    UnboundFieldDescriptorCollection

    Methods

    CreateAddNewRecordSection(Group)

    Creates a new instance of the AddNewRecordSection class for an add new record area within a group.

    Declaration
    public AddNewRecordSection CreateAddNewRecordSection(Group group)
    Parameters
    Type Name Description
    Group group

    The Group.

    Returns
    Type Description
    AddNewRecordSection

    A new AddNewRecordSection.

    CreateCaptionSection(Group)

    Creates a new instance of the Section class for a caption area within a group.

    Declaration
    public Section CreateCaptionSection(Group group)
    Parameters
    Type Name Description
    Group group

    The Group.

    Returns
    Type Description
    Section

    A new section for caption area.

    CreateChildTable(Element, Boolean, Table, SortColumnDescriptorCollection)

    Creates an instance of the RelationDescriptor class.

    Declaration
    public ChildTable CreateChildTable(Element parent, bool hasRecords, Table table, SortColumnDescriptorCollection fields)
    Parameters
    Type Name Description
    Element parent

    The parent element.

    System.Boolean hasRecords

    Specifies if group will be filled with records or nested groups.

    Table table

    The table.

    SortColumnDescriptorCollection fields

    The sortColumns that define the category of the group.

    Returns
    Type Description
    ChildTable

    The new child table..

    CreateColumnHeaderSection(Group)

    Creates a new instance of the Section class for a column header area within a group.

    Declaration
    public Section CreateColumnHeaderSection(Group group)
    Parameters
    Type Name Description
    Group group

    The Group.

    Returns
    Type Description
    Section

    The new column header.

    CreateFilterBarSection(Group)

    Creates a new instance of the Section class for a filter bar area within a group.

    Declaration
    public Section CreateFilterBarSection(Group group)
    Parameters
    Type Name Description
    Group group

    The Group.

    Returns
    Type Description
    Section

    The new filter bar section.

    CreateGroup(Section, Boolean, Table, SortColumnDescriptor)

    Creates an instance of the Group class and initializes it.

    Declaration
    public Group CreateGroup(Section parentSection, bool hasRecords, Table table, SortColumnDescriptor cd)
    Parameters
    Type Name Description
    Section parentSection

    The parent section.

    System.Boolean hasRecords

    Specifies if group will be filled with records or nested groups.

    Table table

    The table.

    SortColumnDescriptor cd

    The sortColumn that defines the category of the group.

    Returns
    Type Description
    Group

    The new group.

    CreateGroup(Section, Boolean, Table, SortColumnDescriptorCollection)

    Creates an instance of the Group class and initializes it.

    Declaration
    public Group CreateGroup(Section parentSection, bool hasRecords, Table table, SortColumnDescriptorCollection fields)
    Parameters
    Type Name Description
    Section parentSection

    The parent section.

    System.Boolean hasRecords

    Specifies if group will be filled with records or nested groups.

    Table table

    The table.

    SortColumnDescriptorCollection fields

    The sortColumns that define the category of the group.

    Returns
    Type Description
    Group

    The new group.

    CreateGroupsDetails(Group, SortColumnDescriptorCollection)

    Creates a new instance of the GroupsDetails class to section the groups area with nested groups within a group

    Declaration
    public GroupsDetails CreateGroupsDetails(Group group, SortColumnDescriptorCollection fields)
    Parameters
    Type Name Description
    Group group

    The parent group.

    SortColumnDescriptorCollection fields

    The sortColumns that define the category of the group.

    Returns
    Type Description
    GroupsDetails

    The new element.

    CreateRecord(Table)

    Creates a new instance of the Record class.

    Declaration
    public Record CreateRecord(Table table)
    Parameters
    Type Name Description
    Table table

    The table.

    Returns
    Type Description
    Record

    The new record.

    CreateRecordsDetails(Group, SortColumnDescriptorCollection)

    Creates a new instance of the RecordsDetails class to section the records area within a group.

    Declaration
    public RecordsDetails CreateRecordsDetails(Group group, SortColumnDescriptorCollection fields)
    Parameters
    Type Name Description
    Group group

    The parent group.

    SortColumnDescriptorCollection fields

    The sortColumns that define the category of the group.

    Returns
    Type Description
    RecordsDetails

    The new element.

    CreateRelatedTable(TableDescriptor, Table)

    Creates a new instance of the Table class for a related table.

    Declaration
    public Table CreateRelatedTable(TableDescriptor td, Table relationParentTable)
    Parameters
    Type Name Description
    TableDescriptor td

    Table descriptor.

    Table relationParentTable

    Related parent table.

    Returns
    Type Description
    Table

    The new table.

    CreateRelationDescriptor()

    Creates an instance of the RelationDescriptor class.

    Declaration
    public RelationDescriptor CreateRelationDescriptor()
    Returns
    Type Description
    RelationDescriptor

    The new relation descriptor.

    CreateSortColumnDescriptorCollection(SortColumnDescriptor)

    Creates an instance of the SortColumnDescriptorCollection collection with one SortColumnDescriptor entry.

    Declaration
    public SortColumnDescriptorCollection CreateSortColumnDescriptorCollection(SortColumnDescriptor cd)
    Parameters
    Type Name Description
    SortColumnDescriptor cd

    The sort column.

    Returns
    Type Description
    SortColumnDescriptorCollection

    A new SortColumnDescriptorCollection.

    CreateSummarySection(Group)

    Creates a new instance of the Section class for a summary area within a group.

    Declaration
    public Section CreateSummarySection(Group group)
    Parameters
    Type Name Description
    Group group

    The Group.

    Returns
    Type Description
    Section

    The new summary section.

    Dispose(Boolean)

    Overridden to manage the unwanted resources.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    SourceListDescriptor.Dispose(Boolean)

    EnableOneTimePopulate()

    Populates TableDescriptor collections with new data.

    Declaration
    public void EnableOneTimePopulate()

    EnsureSummaryDescriptors()

    Repeatedly called from SummaryDescriptorCollection. Lets you recreate the Summaries collection if fields or columns have changed and you have internal summaries (e.g. GridGroupingControl adds a summary for each column to determine maximum length of a column).

    Declaration
    public virtual void EnsureSummaryDescriptors()

    GetModified()

    Determines whether any properties have been modified.

    Declaration
    public virtual bool GetModified()
    Returns
    Type Description
    System.Boolean

    True if any property was modified; Otherwise False.

    GetPrimaryKeySortDescriptors()

    Gets an array of PrimaryKeyColumns.

    Declaration
    public SortColumnDescriptor[] GetPrimaryKeySortDescriptors()
    Returns
    Type Description
    SortColumnDescriptor[]

    Primary key columns.

    GetSortDescriptors()

    Gets a combined array of RelationChildColumns, GroupedColumns and SortedColumns

    Declaration
    public SortColumnDescriptor[] GetSortDescriptors()
    Returns
    Type Description
    SortColumnDescriptor[]

    Relation child columns, grouped columns and sorted columns.

    InitializeFrom(TableDescriptor)

    Initializes this object and copies properties from another object. PropertyChanging and PropertyChanged events are raised for every property that is modified. If both objects are equal, no events are raised.

    Declaration
    public virtual void InitializeFrom(TableDescriptor other)
    Parameters
    Type Name Description
    TableDescriptor other

    The source object.

    InitializePropertyDescriptors()

    For internal use. Initializes the property descriptors.

    Declaration
    public virtual void InitializePropertyDescriptors()

    InitSortByDisplayMemberCols()

    Initializes the sort by display members.

    Declaration
    protected virtual void InitSortByDisplayMemberCols()

    IsChildOf(TableDescriptor)

    Determines whether this is the ChildTableDescriptor of a specified parent TableDescriptor or not.

    Declaration
    public bool IsChildOf(TableDescriptor parent)
    Parameters
    Type Name Description
    TableDescriptor parent

    The parent.

    Returns
    Type Description
    System.Boolean

    True if this is child; False otherwise.

    IsDesignTime()

    Returns true if engine is used by a parent control in design-time.

    Declaration
    public virtual bool IsDesignTime()
    Returns
    Type Description
    System.Boolean

    Returns False.

    IsForeignKeyRelationChildTableDescriptor()

    Determines whether this is the ChildTableDescriptor of a parent relation or not and also if the RelationDescriptor.RelationKind of the parent relations is ForeignKeyReference, RelatedMasterDetails, or ForeignKeyKeyWords.

    Declaration
    public bool IsForeignKeyRelationChildTableDescriptor()
    Returns
    Type Description
    System.Boolean

    True if this is child and the relation kind is ForeignKeyReference, RelatedMasterDetails, or ForeignKeyKeyWords.

    OnAllowEditChanged(EventArgs)

    Occurs when the AllowEditChanged event is done.

    Declaration
    protected virtual void OnAllowEditChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An System.EventArgs contains the event data.

    OnAllowNewChanged(EventArgs)

    Occurs when the AllowNewChanged event is done.

    Declaration
    protected virtual void OnAllowNewChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An System.EventArgs contains the event data.

    OnAllowRemoveChanged(EventArgs)

    Occurs when the AllowRemoveChanged event is done.

    Declaration
    protected virtual void OnAllowRemoveChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An System.EventArgs contains the event data.

    OnCategorizedRecords(TableEventArgs)

    Occurs when the CategorizedRecords event is done.

    Declaration
    protected virtual void OnCategorizedRecords(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    A TableEventArgs contains the event data.

    OnCategorizingRecords(TableEventArgs)

    Occurs when the CategorizingRecords event is done.

    Declaration
    protected virtual void OnCategorizingRecords(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    A TableEventArgs contains the event data.

    OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

    Occurs when the CurrentRecordContextChange event is done.

    Declaration
    protected virtual void OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)
    Parameters
    Type Name Description
    CurrentRecordContextChangeEventArgs e

    A CurrentRecordContextChangeEventArgs contains the event data.

    OnCurrentRecordManagerReset(TableEventArgs)

    Occurs when the CurrentRecordManagerReset event is done.

    Declaration
    protected virtual void OnCurrentRecordManagerReset(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    A TableEventArgs contains the event data.

    OnDisplayElementChanged(DisplayElementChangedEventArgs)

    Occurs when the DisplayElementChanged event is done.

    Declaration
    protected virtual void OnDisplayElementChanged(DisplayElementChangedEventArgs e)
    Parameters
    Type Name Description
    DisplayElementChangedEventArgs e

    A DisplayElementChangedEventArgs contains the event data.

    OnDisplayElementChanging(DisplayElementChangingEventArgs)

    Occurs when the DisplayElementChanging event is done.

    Declaration
    protected virtual void OnDisplayElementChanging(DisplayElementChangingEventArgs e)
    Parameters
    Type Name Description
    DisplayElementChangingEventArgs e

    A DisplayElementChangingEventArgs contains the event data.

    OnExceptionRaised(ExceptionRaisedEventArgs)

    Occurs when the ExceptionRaised event is done.

    Declaration
    protected virtual void OnExceptionRaised(ExceptionRaisedEventArgs e)
    Parameters
    Type Name Description
    ExceptionRaisedEventArgs e

    An ExceptionRaisedEventArgs contains the event data.

    OnGroupAdded(GroupEventArgs)

    Occurs when the GroupAdded event is done.

    Declaration
    protected virtual void OnGroupAdded(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    OnGroupCollapsed(GroupEventArgs)

    Occurs when the GroupCollapsed event is done.

    Declaration
    protected virtual void OnGroupCollapsed(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    OnGroupCollapsing(GroupEventArgs)

    Occurs when the GroupCollapsing event is done.

    Declaration
    protected virtual void OnGroupCollapsing(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    OnGroupExpanded(GroupEventArgs)

    Occurs when the GroupExpanded event is done.

    Declaration
    protected virtual void OnGroupExpanded(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    OnGroupExpanding(GroupEventArgs)

    Occurs when the GroupExpanding event is done.

    Declaration
    protected virtual void OnGroupExpanding(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    OnGroupRemoving(GroupEventArgs)

    Occurs when the GroupRemoving event is done.

    Declaration
    protected virtual void OnGroupRemoving(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs that contains the event data.

    OnGroupSummaryInvalidated(GroupEventArgs)

    Occurs when the GroupSummaryInvalidated event is done.

    Declaration
    protected virtual void OnGroupSummaryInvalidated(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    OnInitializeItemProperties(EventArgs)

    Overridden to raise the initialize item properties event.

    Declaration
    protected override void OnInitializeItemProperties(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The System.EventArgs contains the event data.

    Overrides
    SourceListDescriptor.OnInitializeItemProperties(EventArgs)

    OnInvalidatingCounters(TableEventArgs)

    Occurs when the InvalidatingCounters event is done.

    Declaration
    protected virtual void OnInvalidatingCounters(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    A TableEventArgs contains the event data.

    OnInvalidatingSummaries(TableEventArgs)

    Occurs when the InvalidatingSummaries event is done.

    Declaration
    protected virtual void OnInvalidatingSummaries(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    A TableEventArgs the event data.

    OnItemPropertiesChanged(EventArgs)

    Overridden to raise the item properties changed event.

    Declaration
    protected override void OnItemPropertiesChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The System.EventArgs contains the event data.

    Overrides
    SourceListDescriptor.OnItemPropertiesChanged(EventArgs)

    OnItemPropertiesChanging(EventArgs)

    Overridden to raise the item properties changing event.

    Declaration
    protected override void OnItemPropertiesChanging(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The System.EventArgs contains the event data.

    Overrides
    SourceListDescriptor.OnItemPropertiesChanging(EventArgs)

    OnNameChanged(EventArgs)

    Overridden to raise the name changed event.

    Declaration
    protected override void OnNameChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The System.EventArgs contains the event data.

    Overrides
    SourceListDescriptor.OnNameChanged(EventArgs)

    OnNameChanging(EventArgs)

    Overridden to raise the name changing event.

    Declaration
    protected override void OnNameChanging(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The System.EventArgs contains the event data.

    Overrides
    SourceListDescriptor.OnNameChanging(EventArgs)

    OnPropertyChanged(DescriptorPropertyChangedEventArgs)

    Occurs when the PropertyChanged event is done.

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

    A DescriptorPropertyChangedEventArgs that contains the event data.

    OnPropertyChanging(DescriptorPropertyChangedEventArgs)

    Occurs the PropertyChanging event.

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

    A DescriptorPropertyChangedEventArgs contains the event data.

    OnQueryValue(FieldValueEventArgs)

    Occurs when the QueryValue event is done.

    Declaration
    protected virtual void OnQueryValue(FieldValueEventArgs e)
    Parameters
    Type Name Description
    FieldValueEventArgs e

    The FieldValueEventArgs contains the event data.

    OnRecordCollapsed(RecordEventArgs)

    Occurs when the RecordCollapsed event is done.

    Declaration
    protected virtual void OnRecordCollapsed(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    A RecordEventArgs contains the event data.

    OnRecordCollapsing(RecordEventArgs)

    Occurs when the RecordCollapsing event is done.

    Declaration
    protected virtual void OnRecordCollapsing(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    A RecordEventArgs contains the event data.

    OnRecordDeleted(RecordEventArgs)

    Occurs when the RecordDeleted event is done.

    Declaration
    protected virtual void OnRecordDeleted(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    A RecordEventArgs that contains the event data.

    OnRecordDeleting(RecordEventArgs)

    Occurs when the RecordDeleting event is done.

    Declaration
    protected virtual void OnRecordDeleting(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    A RecordEventArgs contains the event data.

    OnRecordExpanded(RecordEventArgs)

    Occurs when the RecordExpanded event is done.

    Declaration
    protected virtual void OnRecordExpanded(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    A RecordEventArgs contains the event data.

    OnRecordExpanding(RecordEventArgs)

    Occurs when the RecordExpanding event is done.

    Declaration
    protected virtual void OnRecordExpanding(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    A RecordEventArgs contains the event data.

    OnRecordValueChanged(RecordValueChangedEventArgs)

    Occurs when the RecordValueChanged event is done.

    Declaration
    protected virtual void OnRecordValueChanged(RecordValueChangedEventArgs e)
    Parameters
    Type Name Description
    RecordValueChangedEventArgs e

    A RecordValueChangedEventArgs contains the event data.

    OnRecordValueChanging(RecordValueChangingEventArgs)

    Occurs when the RecordValueChanging event is done.

    Declaration
    protected virtual void OnRecordValueChanging(RecordValueChangingEventArgs e)
    Parameters
    Type Name Description
    RecordValueChangingEventArgs e

    A RecordValueChangingEventArgs contains the event data.

    OnSaveValue(FieldValueEventArgs)

    Occurs when the SaveValue event is done.

    Declaration
    protected virtual void OnSaveValue(FieldValueEventArgs e)
    Parameters
    Type Name Description
    FieldValueEventArgs e

    The FieldValueEventArgs contains the event data.

    OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)

    Occurs when the SelectedRecordsChanged event is done.

    Declaration
    protected virtual void OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs e)
    Parameters
    Type Name Description
    SelectedRecordsChangedEventArgs e

    A SelectedRecordsChangedEventArgs that contains the event data.

    OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)

    Occurs when the SelectedRecordsChanging event is done.

    Declaration
    protected virtual void OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs e)
    Parameters
    Type Name Description
    SelectedRecordsChangedEventArgs e

    A SelectedRecordsChangedEventArgs contains the event data.

    OnSortedItemsInGroup(GroupEventArgs)

    Occurs when the SortedItemsInGroup event is done.

    Declaration
    protected virtual void OnSortedItemsInGroup(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    OnSortingItemsInGroup(GroupEventArgs)

    Occurs when the SortingItemsInGroup event is done.

    Declaration
    protected virtual void OnSortingItemsInGroup(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs that contains the event data.

    OnSourceListListChanged(TableListChangedEventArgs)

    Occurs when the SourceListListChanged event is done.

    Declaration
    protected virtual void OnSourceListListChanged(TableListChangedEventArgs e)
    Parameters
    Type Name Description
    TableListChangedEventArgs e

    A TableListChangedEventArgs contains the event data.

    OnSourceListListChangedCompleted(TableListChangedEventArgs)

    Occurs when the SourceListListChangedCompleted event is done.

    Declaration
    protected virtual void OnSourceListListChangedCompleted(TableListChangedEventArgs e)
    Parameters
    Type Name Description
    TableListChangedEventArgs e

    A TableListChangedEventArgs contains the event data.

    OnSourceListRecordChanged(RecordChangedEventArgs)

    Occurs when the SourceListRecordChanged event is done.

    Declaration
    protected virtual void OnSourceListRecordChanged(RecordChangedEventArgs e)
    Parameters
    Type Name Description
    RecordChangedEventArgs e

    A RecordChangedEventArgs contains the event data.

    OnSourceListRecordChanging(RecordChangedEventArgs)

    Occurs when the SourceListRecordChanging event is done.

    Declaration
    protected virtual void OnSourceListRecordChanging(RecordChangedEventArgs e)
    Parameters
    Type Name Description
    RecordChangedEventArgs e

    A RecordChangedEventArgs contains the event data.

    OnTableSourceListChanged(TableEventArgs)

    Occurs when the TableSourceListChanged event is done.

    Declaration
    protected virtual void OnTableSourceListChanged(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    A TableEventArgs contains the event data.

    RaiseQueryValue(FieldValueEventArgs)

    Occurs when the QueryValue event is done.

    Declaration
    public void RaiseQueryValue(FieldValueEventArgs e)
    Parameters
    Type Name Description
    FieldValueEventArgs e

    The FieldValueEventArgs contains the event data.

    RaiseSaveValue(FieldValueEventArgs)

    Occurs when the SaveValue event is done.

    Declaration
    public void RaiseSaveValue(FieldValueEventArgs e)
    Parameters
    Type Name Description
    FieldValueEventArgs e

    The FieldValueEventArgs contains event data.

    ResetExpressionFields()

    Clears the ExpressionFields collection.

    Declaration
    public void ResetExpressionFields()

    ResetFields()

    Resets the Fields collection back to its default state.

    Declaration
    public void ResetFields()

    ResetGroupedColumns()

    Clears the GroupedColumns collection.

    Declaration
    public void ResetGroupedColumns()

    ResetPrimaryKeyColumns()

    Clears the PrimaryKeyColumns collection.

    Declaration
    public void ResetPrimaryKeyColumns()

    ResetRecordFilters()

    Clears the RecordFilters collection.

    Declaration
    public void ResetRecordFilters()

    ResetRelationChildColumns()

    Resets the RelationChildColumns collection.

    Declaration
    public void ResetRelationChildColumns()

    ResetRelations()

    Resets the Relations collection back to its default state.

    Declaration
    public void ResetRelations()

    ResetSortedColumns()

    Clears the SortedColumns collection.

    Declaration
    public void ResetSortedColumns()

    ResetSummaries()

    Clears the Summaries collection.

    Declaration
    public void ResetSummaries()

    ResetTableDescriptor()

    Resets all properties to default settings.

    Declaration
    public virtual void ResetTableDescriptor()

    ResetUnboundFields()

    Resets the UnboundFields collection back to its default state.

    Declaration
    public void ResetUnboundFields()

    ShouldSerializeExpressionFields()

    Determines whether the ExpressionFields collection contains values or not.

    Declaration
    public virtual bool ShouldSerializeExpressionFields()
    Returns
    Type Description
    System.Boolean

    True if the collection is not empty; Otherwise False.

    ShouldSerializeFields()

    Determines whether the Fields collection has been modified from its default state or not.

    Declaration
    public virtual bool ShouldSerializeFields()
    Returns
    Type Description
    System.Boolean

    True if it is modified; False otherwise.

    ShouldSerializeGroupedColumns()

    Determines whether the GroupedColumns collection contains values or not.

    Declaration
    public virtual bool ShouldSerializeGroupedColumns()
    Returns
    Type Description
    System.Boolean

    True if the collection is not empty; Otherwise False.

    ShouldSerializeName()

    Determines whether the Name was modified from its default value.

    Declaration
    public override bool ShouldSerializeName()
    Returns
    Type Description
    System.Boolean

    True if the name was modified; Otherwise False.

    Overrides
    SourceListDescriptor.ShouldSerializeName()

    ShouldSerializePrimaryKeyColumns()

    Determines whether the PrimaryKeyColumns collection contains values or not.

    Declaration
    public virtual bool ShouldSerializePrimaryKeyColumns()
    Returns
    Type Description
    System.Boolean

    True if the collection contains values; Otherwise False.

    ShouldSerializeRecordFilters()

    Determines whether the RecordFilters collection contains values or not.

    Declaration
    public virtual bool ShouldSerializeRecordFilters()
    Returns
    Type Description
    System.Boolean

    True if it contains values; False otherwise.

    ShouldSerializeRelationChildColumns()

    Determines whether the RelationChildColumns collection was manually modified or not.

    Declaration
    public bool ShouldSerializeRelationChildColumns()
    Returns
    Type Description
    System.Boolean

    True if it was modified; Otherwise False.

    ShouldSerializeRelations()

    Determines whether the Relations collection or child objects have been modified from its default state or not.

    Declaration
    public virtual bool ShouldSerializeRelations()
    Returns
    Type Description
    System.Boolean

    True if the objects have been modified; Otherwise False.

    ShouldSerializeSortedColumns()

    Determines whether the SortedColumns collection contains values or not.

    Declaration
    public virtual bool ShouldSerializeSortedColumns()
    Returns
    Type Description
    System.Boolean

    True if it contains values.

    ShouldSerializeSummaries()

    Determines whether the Summaries collection contains values or not.

    Declaration
    public virtual bool ShouldSerializeSummaries()
    Returns
    Type Description
    System.Boolean

    True if it contains values.

    ShouldSerializeUnboundFields()

    Determines whether the UnboundFields collection has been modified from its default state or not.

    Declaration
    public virtual bool ShouldSerializeUnboundFields()
    Returns
    Type Description
    System.Boolean

    True if the collection has been modified; Otherwise False.

    ShouldSortByDisplayMember(SortColumnDescriptor)

    Determines whether the specified column should be sorted or not by the DisplayMember.

    Declaration
    public virtual bool ShouldSortByDisplayMember(SortColumnDescriptor cd)
    Parameters
    Type Name Description
    SortColumnDescriptor cd

    The column.

    Returns
    Type Description
    System.Boolean

    Returns False.

    Remarks

    Default behavior of the method is to return false. GridGroupingControl overrides this method and checks whether the GridColumnDescriptor associated with column has its GridColumnDescriptor.SortByDisplayMember property set to true.

    ToString()

    Overridden to get a string holding the current object.

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

    String representation of the current object.

    Overrides
    DescriptorBase.ToString()

    Events

    AllowEditChanged

    Occurs when the AllowEdit property is changed.

    Declaration
    public event EventHandler AllowEditChanged
    Event Type
    Type
    System.EventHandler

    AllowNewChanged

    Occurs when the AllowNew property is changed.

    Declaration
    public event EventHandler AllowNewChanged
    Event Type
    Type
    System.EventHandler

    AllowRemoveChanged

    Occurs when the AllowRemove property is changed.

    Declaration
    public event EventHandler AllowRemoveChanged
    Event Type
    Type
    System.EventHandler

    CategorizedRecords

    Occurs after records were categorized after a table was marked dirty (TableDirty).

    Declaration
    public event TableEventHandler CategorizedRecords
    Event Type
    Type
    TableEventHandler
    Remarks

    When TableDirty is set True, e.g. because schema information for a table was changed or because the grouped columns were changed, the table will categorize records on demand the first time information about a record is accessed. At that time, the EnsureInitialized(Object) of the Table will start categorization.

    CategorizingRecords

    Occurs before records are categorized after a table was marked dirty (TableDirty).

    Declaration
    public event TableEventHandler CategorizingRecords
    Event Type
    Type
    TableEventHandler
    Remarks

    When TableDirty is set True, e.g. because schema information for a table was changed or because the grouped columns were changed, the table will categorize records on demand the first time information about a record is accessed. At that time, the EnsureInitialized(Object) of the Table will start categorization.

    CurrentRecordContextChange

    Occurs before and after the status of the current record is changed. Check the Action of the CurrentRecordContextChangeEventArgs to get information which current record state was changed.

    Declaration
    public event CurrentRecordContextChangeEventHandler CurrentRecordContextChange
    Event Type
    Type
    CurrentRecordContextChangeEventHandler

    CurrentRecordManagerReset

    Occurs when the Reset() method of the CurrentRecordManager was called.

    Declaration
    public event TableEventHandler CurrentRecordManagerReset
    Event Type
    Type
    TableEventHandler
    Remarks

    The GridGroupingControl listens to this event and resets any "Current Cell" state when this event is raised.

    DisplayElementChanged

    Occurs when the number of visible elements is changed.

    Declaration
    public event DisplayElementChangedEventHandler DisplayElementChanged
    Event Type
    Type
    DisplayElementChangedEventHandler

    DisplayElementChanging

    Occurs when the number of visible elements is changed.

    Declaration
    public event DisplayElementChangingEventHandler DisplayElementChanging
    Event Type
    Type
    DisplayElementChangingEventHandler

    ExceptionRaised

    Occurs when an unknown exception has been cached while modifying underlying data in the data source.

    Declaration
    public event ExceptionRaisedEventHandler ExceptionRaised
    Event Type
    Type
    ExceptionRaisedEventHandler
    Remarks

    If necessary, you can re-throw the exception in your event handler.

    GroupAdded

    Occurs when a new group is added in a table after the table was categorized and when a record was changed. The event does not occur during categorization of the table. See the CategorizedRecords elements to when categorization finished.

    Declaration
    public event GroupEventHandler GroupAdded
    Event Type
    Type
    GroupEventHandler

    GroupCollapsed

    Occurs before a group is collapsed.

    Declaration
    public event GroupEventHandler GroupCollapsed
    Event Type
    Type
    GroupEventHandler

    GroupCollapsing

    Occurs before a group is collapsed.

    Declaration
    public event GroupEventHandler GroupCollapsing
    Event Type
    Type
    GroupEventHandler

    GroupExpanded

    Occurs after a group is expanded.

    Declaration
    public event GroupEventHandler GroupExpanded
    Event Type
    Type
    GroupEventHandler

    GroupExpanding

    Occurs before a group is expanded.

    Declaration
    public event GroupEventHandler GroupExpanding
    Event Type
    Type
    GroupEventHandler

    GroupRemoving

    Occurs when a group was removed from a table after the table was categorized and when a record was changed. The event does not occur during categorization of the table. See the CategorizedRecords elements to when categorization finished.

    Declaration
    public event GroupEventHandler GroupRemoving
    Event Type
    Type
    GroupEventHandler

    GroupSummaryInvalidated

    Occurs when a summary has been marked dirty.

    Declaration
    public event GroupEventHandler GroupSummaryInvalidated
    Event Type
    Type
    GroupEventHandler
    Remarks

    The GridGroupingControl listens to this event and will force a repaint of the specified summary if it is visible when this event is raised.

    InvalidatingCounters

    Occurs when the InvalidateCounterTopDown(Boolean) of a Table is called and before all counters are marked dirty.

    Declaration
    public event TableEventHandler InvalidatingCounters
    Event Type
    Type
    TableEventHandler

    InvalidatingSummaries

    Occurs when the InvalidateSummariesTopDown() of a Table is called and before all summaries in that table are marked dirty.

    Declaration
    public event TableEventHandler InvalidatingSummaries
    Event Type
    Type
    TableEventHandler

    PropertyChanged

    Occurs when a property or child object has been changed.

    Declaration
    public event DescriptorPropertyChangedEventHandler PropertyChanged
    Event Type
    Type
    DescriptorPropertyChangedEventHandler

    PropertyChanging

    Occurs before a property or child object is changed.

    Declaration
    public event DescriptorPropertyChangedEventHandler PropertyChanging
    Event Type
    Type
    DescriptorPropertyChangedEventHandler

    QueryFilterText

    Occurs when the records are filtered through RecordFilterDescriptor. This event will be triggered when RecordFilterDescriptor gets a cell value based on a column in a record to filter that record based on the criteria.

    Declaration
    public event QueryFilterTextEventHandler QueryFilterText
    Event Type
    Type
    QueryFilterTextEventHandler
    Remarks

    The cell value can be modified at the user level using this event if end user wants to modify the record cell values on filtering. So while filtering records, RecordFilterDescriptor will check the modified cell values in this event to meet the criteria of the filter condition.

    QueryValue

    Raises when a value for a field descriptor and record is returned.

    Declaration
    public event FieldValueEventHandler QueryValue
    Event Type
    Type
    FieldValueEventHandler
    Remarks

    See the Grid.Grouping\Samples\CustomSummary. sample how to use this event with unbound field descriptors.

    RecordCollapsed

    Occurs after a record with nested tables is collapsed.

    Declaration
    public event RecordEventHandler RecordCollapsed
    Event Type
    Type
    RecordEventHandler

    RecordCollapsing

    Occurs before a record with nested tables is collapsed.

    Declaration
    public event RecordEventHandler RecordCollapsing
    Event Type
    Type
    RecordEventHandler

    RecordDeleted

    Occurs after a record is deleted.

    Declaration
    public event RecordEventHandler RecordDeleted
    Event Type
    Type
    RecordEventHandler
    Remarks

    This event is raised only when the Table or Record triggers the deletion. If the underlying source list deletes the record, a SourceListListChanged event is raised instead.

    RecordDeleting

    Occurs before a record is deleted.

    Declaration
    public event RecordEventHandler RecordDeleting
    Event Type
    Type
    RecordEventHandler
    Remarks

    This event is raised only when the Table or Record triggers the deletion. If the underlying source list deletes the record, a SourceListListChanged event is raised instead.

    RecordExpanded

    Occurs after a record with nested tables is expanded.

    Declaration
    public event RecordEventHandler RecordExpanded
    Event Type
    Type
    RecordEventHandler

    RecordExpanding

    Occurs before a record with nested tables is expanded.

    Declaration
    public event RecordEventHandler RecordExpanding
    Event Type
    Type
    RecordEventHandler

    RecordValueChanged

    Occurs when a RecordFieldCell cell's value is changed and after Record.SetValue returned.

    Declaration
    public event RecordValueChangedEventHandler RecordValueChanged
    Event Type
    Type
    RecordValueChangedEventHandler

    RecordValueChanging

    Occurs when a RecordFieldCell cell's value is changed and before Record.SetValue is called.

    Declaration
    public event RecordValueChangingEventHandler RecordValueChanging
    Event Type
    Type
    RecordValueChangingEventHandler

    SaveValue

    Occurs when a value for a field descriptor and record is saved.

    Declaration
    public event FieldValueEventHandler SaveValue
    Event Type
    Type
    FieldValueEventHandler
    Remarks

    See the Grid.Grouping\Samples\CustomSummary. sample how to use this event with unbound field descriptors.

    SelectedRecordsChanged

    Occurs after the SelectedRecords collection was modified.

    Declaration
    public event SelectedRecordsChangedEventHandler SelectedRecordsChanged
    Event Type
    Type
    SelectedRecordsChangedEventHandler

    SelectedRecordsChanging

    Occurs before the SelectedRecords collection is modified.

    Declaration
    public event SelectedRecordsChangedEventHandler SelectedRecordsChanging
    Event Type
    Type
    SelectedRecordsChangedEventHandler

    SortedItemsInGroup

    Occurs after the records for a group were sorted.

    Declaration
    public event GroupEventHandler SortedItemsInGroup
    Event Type
    Type
    GroupEventHandler
    Remarks

    The engine has a built-in optimization for sorting columns that allows it to perform the sorting on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and then you change the sort order of city, it is not necessary to sort the whole table. Instead, the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and SortedItemsInGroup events are fired in such cases when a specific group was sorted on demand.

    If the whole table was set dirty (see TableDirty), then the whole table is simply recategorized. In that case, only a CategorizedElements event is raised but no SortedItemsInGroup event.

    SortingItemsInGroup

    Occurs before the records for a group are sorted.

    Declaration
    public event GroupEventHandler SortingItemsInGroup
    Event Type
    Type
    GroupEventHandler
    Remarks

    The engine has a built-in optimization for sorting columns that allows it to perform the sorting on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and you change the sort order of city. It is not necessary to sort the whole table. Instead the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and SortedItemsInGroup events are fired in such case when a specific group is sorted on demand.

    If the whole table was set dirty (see TableDirty), then the whole table is simply recategorized. In that case, only a CategorizedElements event is raised but no SortingItemsInGroup event.

    SourceListListChanged

    Occurs before the Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list. More detailed SourceListRecordChanged events will be raised after this event.

    Declaration
    public event TableListChangedEventHandler SourceListListChanged
    Event Type
    Type
    TableListChangedEventHandler
    Remarks

    The reason for firing this event is to give a programmer chance to react to an System.ComponentModel.IBindingList.ListChanged event before the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged event.

    SourceListListChangedCompleted

    Occurs after the Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list.

    Declaration
    public event TableListChangedEventHandler SourceListListChangedCompleted
    Event Type
    Type
    TableListChangedEventHandler
    Remarks

    The reason for firing this event is to give a programmer the chance to react to an System.ComponentModel.IBindingList.ListChanged event right after the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged event.

    SourceListRecordChanged

    Occurs when a record in the underlying datasource was added, removed, or changed and after the Table was updated with that change.

    Declaration
    public event RecordChangedEventHandler SourceListRecordChanged
    Event Type
    Type
    RecordChangedEventHandler

    SourceListRecordChanging

    Occurs when a record in the underlying datasource was added, removed, or changed and before the Table is updated with that change.

    Declaration
    public event RecordChangedEventHandler SourceListRecordChanging
    Event Type
    Type
    RecordChangedEventHandler

    TableSourceListChanged

    Occurs after the data source is replaced.

    Declaration
    public event TableEventHandler TableSourceListChanged
    Event Type
    Type
    TableEventHandler

    Explicit Interface Implementations

    ITableEventsTarget.OnCategorizedRecords(TableEventArgs)

    Occurs when the records are categorized.

    Declaration
    void ITableEventsTarget.OnCategorizedRecords(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    The TableEventArgs contains the event data.

    ITableEventsTarget.OnCategorizingRecords(TableEventArgs)

    Occurs when the records are getting categorize.

    Declaration
    void ITableEventsTarget.OnCategorizingRecords(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    The TableEventArgs contains the event data.

    ITableEventsTarget.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

    Occurs when the current record context gets change.

    Declaration
    void ITableEventsTarget.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)
    Parameters
    Type Name Description
    CurrentRecordContextChangeEventArgs e

    The CurrentRecordContextChangeEventArgs contains the event data.

    ITableEventsTarget.OnCurrentRecordManagerReset(TableEventArgs)

    Occurs when the current record manager resets

    Declaration
    void ITableEventsTarget.OnCurrentRecordManagerReset(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    The TableEventArgs contains the event data.

    ITableEventsTarget.OnDisplayElementChanged(DisplayElementChangedEventArgs)

    Occurs when the display element gets changed.

    Declaration
    void ITableEventsTarget.OnDisplayElementChanged(DisplayElementChangedEventArgs e)
    Parameters
    Type Name Description
    DisplayElementChangedEventArgs e

    The DisplayElementChangedEventArgs contains the event data.

    ITableEventsTarget.OnDisplayElementChanging(DisplayElementChangingEventArgs)

    Occurs when the display element is changing.

    Declaration
    void ITableEventsTarget.OnDisplayElementChanging(DisplayElementChangingEventArgs e)
    Parameters
    Type Name Description
    DisplayElementChangingEventArgs e

    A DisplayElementChangedEventArgs contains the event data.

    ITableEventsTarget.OnExceptionRaised(ExceptionRaisedEventArgs)

    Occurs when the exception is raised.

    Declaration
    void ITableEventsTarget.OnExceptionRaised(ExceptionRaisedEventArgs e)
    Parameters
    Type Name Description
    ExceptionRaisedEventArgs e

    The ExceptionRaisedEventArgs contains the event data.

    ITableEventsTarget.OnGroupAdded(GroupEventArgs)

    Occurs when the group is added.

    Declaration
    void ITableEventsTarget.OnGroupAdded(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data.

    ITableEventsTarget.OnGroupCollapsed(GroupEventArgs)

    Occurs when the group gets collapsed.

    Declaration
    void ITableEventsTarget.OnGroupCollapsed(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data.

    ITableEventsTarget.OnGroupCollapsing(GroupEventArgs)

    Occurs when the group gets collapsing.

    Declaration
    void ITableEventsTarget.OnGroupCollapsing(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    A GroupEventArgs contains the event data.

    ITableEventsTarget.OnGroupExpanded(GroupEventArgs)

    Occurs when the group is expanded.

    Declaration
    void ITableEventsTarget.OnGroupExpanded(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data.

    ITableEventsTarget.OnGroupExpanding(GroupEventArgs)

    Occurs when the group gets expanding.

    Declaration
    void ITableEventsTarget.OnGroupExpanding(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data.

    ITableEventsTarget.OnGroupRemoving(GroupEventArgs)

    Occurs when the records in the group are removing.

    Declaration
    void ITableEventsTarget.OnGroupRemoving(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data.

    ITableEventsTarget.OnGroupSummaryInvalidated(GroupEventArgs)

    Occurs when the group summary gets reseted.

    Declaration
    void ITableEventsTarget.OnGroupSummaryInvalidated(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data.

    ITableEventsTarget.OnInvalidatingCounters(TableEventArgs)

    Occurs when the counters are getting reset.

    Declaration
    void ITableEventsTarget.OnInvalidatingCounters(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    The TableEventArgs contains the event data.

    ITableEventsTarget.OnInvalidatingSummaries(TableEventArgs)

    Occurs when the summary is getting reset.

    Declaration
    void ITableEventsTarget.OnInvalidatingSummaries(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    The TableEventArgs contains the event data.

    ITableEventsTarget.OnRecordCollapsed(RecordEventArgs)

    Occurs when the records gets collapsed.

    Declaration
    void ITableEventsTarget.OnRecordCollapsed(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    The RecordEventArgscontains the event data.

    ITableEventsTarget.OnRecordCollapsing(RecordEventArgs)

    Occurs when the record gets collapsing.

    Declaration
    void ITableEventsTarget.OnRecordCollapsing(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    The RecordEventArgs contains the event data.

    ITableEventsTarget.OnRecordDeleted(RecordEventArgs)

    Occurs when the record gets deleted.

    Declaration
    void ITableEventsTarget.OnRecordDeleted(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    The RecordEventArgs contains the event data.

    ITableEventsTarget.OnRecordDeleting(RecordEventArgs)

    Occurs when the record gets deleting.

    Declaration
    void ITableEventsTarget.OnRecordDeleting(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    The RecordEventArgs contains the event data.

    ITableEventsTarget.OnRecordExpanded(RecordEventArgs)

    Occurs when the records are expanded.

    Declaration
    void ITableEventsTarget.OnRecordExpanded(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    The RecordEventArgs contains the event data.

    ITableEventsTarget.OnRecordExpanding(RecordEventArgs)

    Occurs when the records are expanding.

    Declaration
    void ITableEventsTarget.OnRecordExpanding(RecordEventArgs e)
    Parameters
    Type Name Description
    RecordEventArgs e

    The RecordEventArgs contains the event data.

    ITableEventsTarget.OnRecordValueChanged(RecordValueChangedEventArgs)

    Occurs when the record value is changed.

    Declaration
    void ITableEventsTarget.OnRecordValueChanged(RecordValueChangedEventArgs e)
    Parameters
    Type Name Description
    RecordValueChangedEventArgs e

    The RecordValueChangedEventArgs contains the event data.

    ITableEventsTarget.OnRecordValueChanging(RecordValueChangingEventArgs)

    Occurs when the record value getting change.

    Declaration
    void ITableEventsTarget.OnRecordValueChanging(RecordValueChangingEventArgs e)
    Parameters
    Type Name Description
    RecordValueChangingEventArgs e

    A RecordValueChangedEventArgs contains the event data.

    ITableEventsTarget.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)

    Occurs when the selected records gets changed.

    Declaration
    void ITableEventsTarget.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs e)
    Parameters
    Type Name Description
    SelectedRecordsChangedEventArgs e

    The SelectedRecordsChangedEventArgs contains the event data.

    ITableEventsTarget.OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)

    Declaration
    void ITableEventsTarget.OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs e)
    Parameters
    Type Name Description
    SelectedRecordsChangedEventArgs e

    ITableEventsTarget.OnSortedItemsInGroup(GroupEventArgs)

    Occurs when the items in the groups gets sorted.

    Declaration
    void ITableEventsTarget.OnSortedItemsInGroup(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data.

    ITableEventsTarget.OnSortingItemsInGroup(GroupEventArgs)

    Occurs when the items in the group is getting sort.

    Declaration
    void ITableEventsTarget.OnSortingItemsInGroup(GroupEventArgs e)
    Parameters
    Type Name Description
    GroupEventArgs e

    The GroupEventArgs contains the event data

    ITableEventsTarget.OnSourceListListChanged(TableListChangedEventArgs)

    Occurs when the source list gets changed.

    Declaration
    void ITableEventsTarget.OnSourceListListChanged(TableListChangedEventArgs e)
    Parameters
    Type Name Description
    TableListChangedEventArgs e

    The TableListChangedEventArgs contains the event data.

    ITableEventsTarget.OnSourceListListChangedCompleted(TableListChangedEventArgs)

    Occurs when the source list changed is completed.

    Declaration
    void ITableEventsTarget.OnSourceListListChangedCompleted(TableListChangedEventArgs e)
    Parameters
    Type Name Description
    TableListChangedEventArgs e

    The TableListChangedEventArgs contains the event data.

    ITableEventsTarget.OnSourceListRecordChanged(RecordChangedEventArgs)

    Occurs when the record source list gets changed.

    Declaration
    void ITableEventsTarget.OnSourceListRecordChanged(RecordChangedEventArgs e)
    Parameters
    Type Name Description
    RecordChangedEventArgs e

    The RecordChangedEventArgs contains the event data.

    ITableEventsTarget.OnSourceListRecordChanging(RecordChangedEventArgs)

    Occurs when the source list record is getting change.

    Declaration
    void ITableEventsTarget.OnSourceListRecordChanging(RecordChangedEventArgs e)
    Parameters
    Type Name Description
    RecordChangedEventArgs e

    The RecordChangedEventArgs contains the event data.

    ITableEventsTarget.OnTableSourceListChanged(TableEventArgs)

    Occurs when the table source list gets changed.

    Declaration
    void ITableEventsTarget.OnTableSourceListChanged(TableEventArgs e)
    Parameters
    Type Name Description
    TableEventArgs e

    The TableEventArgs contains the event data.

    Implements

    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IItemPropertiesSource
    System.ComponentModel.ITypedList
    ITableEventsTarget
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved