WinForms

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

    Show / Hide Table of Contents

    Class Engine

    Represents the class that provides the engine to set the main data source for the whole engine. The TableDescriptor will pick up the ItemProperties (schema information) from the SourceList and table will be initialized at run-time with records from the list.

    Inheritance
    System.Object
    ShouldSerializeBasedPersisterType
    DescriptorBase
    Engine
    GridEngineBase
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    ITableEventsTarget
    Inherited Members
    DescriptorBase.Dispose()
    DescriptorBase.OnDisposed(EventArgs)
    DescriptorBase.CanResetValue()
    DescriptorBase.ShouldSerialize()
    DescriptorBase.Disposing
    DescriptorBase.InDisposed
    DescriptorBase.IsDisposed
    DescriptorBase.Disposed
    ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)
    ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)
    ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)
    ShouldSerializeBasedPersisterType.CheckAllProperties
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Grouping
    Assembly: Syncfusion.Grouping.Base.dll
    Syntax
    public class Engine : DescriptorBase, ICustomTypeDescriptor, IDisposable, ITableEventsTarget
    Remarks

    TableDescriptor is browsable. You can modify its collections and properties in the designer.

    By default TableDescriptor is auto-populated. If you do not modify its settings and later change the data source, it will be automatically reinitialized. If you have made modifications to TableDescriptor and change the SourceList, the modifications will be kept. To discard modifications of a TableDescriptor, you need to explicitly call ResetTableDescriptor.

    Table is dependent on information provided by TableDescriptor and the records from SourceList. It is created on the fly and can not be designed with designer.

    Constructors

    Engine()

    Initializes the new Engine.

    Declaration
    public Engine()

    Fields

    HelpTracing

    Declaration
    public static bool HelpTracing
    Field Value
    Type Description
    System.Boolean

    ThrowExceptionIfSourceListSetEntryNotFound

    Declaration
    public static bool ThrowExceptionIfSourceListSetEntryNotFound
    Field Value
    Type Description
    System.Boolean

    VerboseEnsureObjectLifeTime

    Debug helper. Produces a debug log for creation and destruction of important objects.

    Declaration
    public static bool VerboseEnsureObjectLifeTime
    Field Value
    Type Description
    System.Boolean

    Properties

    AbortNestedCollectionsRecursionLevel

    Gets or sets the amount of recursion allowed when stepping into nested collections of a type with self-relations. Default is 5.

    Declaration
    public static int AbortNestedCollectionsRecursionLevel { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    The property is checked by the RelationDescriptor collection to avoid an infinite recursion a type has a self-relations.

    AbortNestedFieldsRecursionLevel

    Gets or sets the amount of recursion allowed when stepping into nested properties of a type. Default is 3.

    Declaration
    public static int AbortNestedFieldsRecursionLevel { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    The property is checked by the FieldDescriptor collection to avoid an infinite recursion when two types reference each other as nested properties.

    If you have a situation where Class1 has a property of type Class2 and Class2 has a property of type Class1 it is recommended that you mark one of the properties as Browsable(false). If you do not mark it Browsable(false) then the grid will step into a recursion and abort this recursion when the level reaches the value specified for MaximumNestedFieldLevel.

    AllowedOptimizations

    Gets or sets the value of the allowed optimizations.

    Declaration
    public EngineOptimizations AllowedOptimizations { get; set; }
    Property Value
    Type Description
    EngineOptimizations
    Remarks

    Specifies optimizations the engine is allowed use when applicable. These optimizations can be used in combination with EngineCounter setting.

    AllowSaveIntoEditableObjectWhileEditing

    Gets or sets the value indicating whether to allow save the edit-able object or not when it is in edit-mode.

    Declaration
    public static bool AllowSaveIntoEditableObjectWhileEditing { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    This flag specifies whether the engine should save a value into the current editable row of the underlying datasource when BeginEdit was called on a record and the field is modified. Saving the value into the row in the datasource has the benefit that validation can occur in the datasource immediately once the end-user moves to the next cell in the current record.

    Set this flag to false to save values into the current record only at the time EndEdit was called (when the user navigates away from the current record and wants to commit changes.) Default is true.

    AllowSetRelatedTablesDirty

    Gets or sets a value whether the related tables are set dirty or not when the parent table receives a ListChangedType.Reset in its ListChanged event. The default value is True.

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

    AllowSkipItemChangedWhileEditing

    Gets or sets the value indicating whether to allow skip the item changes or not when it is in edit mode.

    Declaration
    public static bool AllowSkipItemChangedWhileEditing { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    A BindingList in .NET 2.0 immeditaley raises a ItemChanged event after each change even if BeginEdit was called. The following flag specifies whether to proceed with ItemChanged event handler logic only if the record was modified outside the engine or if the CurrentRecordManager called EndEdit. Default is true.

    AllowSwapDataViewWithDataTableList

    Gets or sets the value indicating whether the engine can wrap access to a DataTable or not with a DataTableList which provides optimized access to the rows of the DataTable.

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

    The Engine will access a DataTable through this wrapper class instead of accessing records through the DataTable.DefaultView to increase performance when adding, removing and changing records when AllowSwapDataViewWithDataTableList is enabled. Default is False.

    AutoPopulateRelations

    Gets or sets a value indicating whether to auto-populate the relations or not.

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

    This property affects the auto-population of the RelationDescriptorCollection.

    It specifies if relations should be automatically generated when you assign a DataSource a DataTable with constraints or a DataSet with relations defined. Default is True.

    CacheRecordValues

    Gets or sets a value indicating whether the engine should cache copies of the old values of the record or not.

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

    You can access these values with the Record.GetOldValue method. Setting this property will override the default value returned by ShouldCreateRecordWithCache.

    CounterLogic

    Gets or sets the counter logic.

    Declaration
    public EngineCounters CounterLogic { get; set; }
    Property Value
    Type Description
    EngineCounters
    Remarks

    Specifies the counter logic to be used within the engine. If you have a large datasource and need support for groups and filtered records you can reduce the memory footprint by selectively disabling counters you do not need in your application.

    See EngineOptimizations.DisableCounters for completely disabling counter logic for the RecordsDetails collection if you do not need grouping and filtering.

    See EngineOptimizations.VirtualMode for using the engine in a virtual mode if you do not need support for sorting.

    Culture

    Gets or sets the culture information which holds rules for parsing and formatting numbers and dates. in expression fields.

    Declaration
    public CultureInfo Culture { get; set; }
    Property Value
    Type Description
    System.Globalization.CultureInfo
    Remarks

    In invariant format numbers and dates are always in English format, e.g. use a '.' as decimal separator and dates in format mm/dd/yy. In UI culture dependent format the decimal separator can be a ',' or some other setting specified in CultureInfo.CurrentUICulture.

    DefaultEnableAutoSize

    Gets or sets a value indicating whether to defaultly AutoSize behavior should be enabled or not.
    Declaration
    public static bool DefaultEnableAutoSize { get; set; }
    Property Value
    Type Description
    System.Boolean

    DefaultUseLazyUniformChildListRelation

    When you use the new UniformChildList behavior (i.e. when UseOldUniformChildListRelation = false) you can specify with this UseLazyUniformChildListRelation property whether the engine should access and enumerate the child collections only once the user expands a record. This will speed up load time of the grid and reduce memory usage when not all records get expanded.

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

    DefaultUseOldListChangedHandler

    With version 4.4 the engine changed the way how the ListChanged event is handled internally to fix short-comings with performance of the code that was in place earlier. This property lets you switch back the behavior of the engine to the old mechanism if you notice compatibility issues. This static member defines the default value for the instance-specific UseOldListChangedHandler property for all engines in your application.

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

    DefaultUseOldUniformChildListRelation

    With version 4.2 the engine changed the way how UniformChildList relations are handled internally to fix short-comings of the design that was in place earlier. This property lets you switch back the behavior of the engine to the old mechanism if you notice compatibility issues. This static member defines the default value for the instance-specific UseOldUniformChildListRelation property for all engines in your application.

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

    EnableAutoSize

    Gets or sets a value indicating whether the AutoSize behavior should be enabled or not.

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

    ForceShowCurrentRecord

    Gets or sets a value indicating whether the engine should ensure that a record is visible or not and all its parent elements are expanded when setting the current record. The default setting is true.

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

    ForwardTableEvents

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

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

    InInitializeFrom

    For internal use.

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

    InSetSourceList

    Returns True when the SetSourceList(IEnumerable) method is called and False after the method returns.

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

    InSourceListChanged

    Gets the value indicating whether the SourceListChanged event is raised or not.

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

    Returns True when the SourceListChanged event is raised and False after the event returns.

    IsDynamicData

    Gets or sets a value whether the bounded data source is composed of dynamic objects or not.

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

    Applicable only for .NET Framework 4.0 and later.

    MaxNestedCollectionRecurseLevel

    Specifies the number of levels to recurse when ShowNestedPropertiesCollections is set to true.

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

    Default value is AbortNestedCollectionsRecursionLevel. You can reset this property by setting it's value to -1.

    Remarks

    While AbortNestedCollectionsRecursionLevel lets you specify this recursion level globally, this property lets you specify it for a particular Engine instance. Take a look at AbortNestedCollectionsRecursionLevel for more information.

    MaxNestedFieldRecurseLevel

    Gets or sets the number of levels to recurse when ShowNestedPropertiesFields is set to true.

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

    Default value is AbortNestedFieldsRecursionLevel. You can reset this property by setting it's value to -1.

    Remarks

    While AbortNestedFieldsRecursionLevel lets you specify this recursion level globally, this property lets you specify it for a particular Engine instance. Take a look at AbortNestedFieldsRecursionLevel for more information.

    RaiseSourceListChangedEventsOnEngineOnly

    When the engine handles the ListChanged event it will itself raise numerous events. When set to true this the events will only be raised on the Engine object. If set to false then events will also be raised on inner objects (will bubble up on nested tables which caused some performance overhead). Property will only have effect if UseOldListChangedHandler = false.

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

    RecordAsDisplayElements

    Gets or sets the value indicating whether the record is set as Display elements or not.

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

    Set this True if you do not want the engine to treat Record and ColumnHeaderSection elements as ContainerElements and instead have these elements be returned as a display element in the Table.DisplayElements collection.

    With a GridGroupingControl, you must not change this property since a GridGroupingControl relies on the behavior that a record is not a display element but a container for rows and nested tables.

    ShouldCreateRecordWithCache

    Gets the value indicating whether to create record with cache or not.

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

    Returns true if underlying data source does not raise ColumnChanging events and therefore the record should cached old values in order to be able to compare values when a ListChanged event is handled. The property returns the value of CacheRecordValues if you explicitly set the CacheRecordValues property thus allowing you to override the default caching behavior of the engine.

    ShowDefaultValuesInAddNewRecord

    Gets or sets a value indicating whether the default value for fields in the AddNewRecord should be shown or not when it is not in edit-mode.

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

    If the ShowDefaultValuesInAddNewRecord is false then the default values will only be assigned when AddNewRecord.BeginEdit is called. Prior calls to AddNewRecord will return no value in that case.

    ShowNestedPropertiesFields

    Gets or sets a value indicating whether to show the nested property fields or not.

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

    This property affects the auto-population of the FieldDescriptorCollection.

    It specifies if individual fields should be added for every property of a type when a type has nested properties. You can also control this behavior at run-time with the QueryShowNestedPropertiesFields event. Default is True.

    ShowRelationFields

    Gets or sets the value to shoe the relation fields.

    Declaration
    public ShowRelationFields ShowRelationFields { get; set; }
    Property Value
    Type Description
    ShowRelationFields
    Remarks

    This property affects the auto-population of the FieldDescriptorCollection.

    It specifies if dependent fields from a related table in a foreign key relation (or related collection) should be added to the main tables FieldDescriptorCollection. You can also control this behavior at run-time with the QueryShowRelationDisplayFields event. Default is ShowRelationFields.ShowDisplayFieldsOnly.

    SortMappingNames

    Gets or sets a value indicating whether the engine should sort mapping names alphabetically or not in the drop-down editors of the property grid. Default is false.

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

    SourceListSet

    Gets the reference to the SourceListSet that maintains a collection of IList or DataTables that are used by main table or related tables as data sources.

    Declaration
    public SourceListSet SourceListSet { get; }
    Property Value
    Type Description
    SourceListSet

    SourceListVersion

    Gets the version number for the underlying data source. This number is increased each time SetSourceList(IEnumerable) is called.

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

    SupportsYAmount

    Gets the value indicating whether it supports the y-amount.

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

    Table

    Gets the Table object and manages the records from the engine's DataSource and provides access to records and grouped elements through several collection classes, most prominent the DisplayElementsInTableCollection.

    Declaration
    public Table Table { get; }
    Property Value
    Type Description
    Table

    TableDescriptor

    Gets the table schema information of the root table in the data source.

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

    TableDirtyOnSourceListReset

    Gets or sets a value whether the engine should set TableDirtyOnSourceListReset to true or not when the data source raises a ListChanged event with ListChangedType.Reset notification. The default value is False.

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

    UseInvariantCulture

    Gets or sets a value whether numbers and dates in expressions should be in invariant format or UI culture dependent format.

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

    In invariant format numbers and dates are always in English format, e.g. use a '.' as decimal separator and dates in format mm/dd/yy. In UI culture dependent format the decimal separator can be a ',' or some other setting specified in CultureInfo.CurrentUICulture.

    UseLazyUniformChildListRelation

    When you use the new UniformChildList behavior (i.e. when UseOldUniformChildListRelation = false) you can specify with this UseLazyUniformChildListRelation property whether the engine should access and enumerate the child collections only once the user expands a record. This will speed up load time of the grid and reduce memory usage when not all records get expanded.

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

    UseOldListChangedHandler

    With version 4.4 the engine changed the way how the ListChanged event is handled internally to fix short-comings with performance of the code that was in place earlier. This property lets you switch back the behavior of the engine to the old mechanism if you notice compatibility issues. The default value is false.

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

    UseOldUniformChildListRelation

    With version 4.2 the engine changed the way how UniformChildList relations are handled internally to fix short-comings of the design that was in place earlier. This property lets you switch back the behavior of the engine to the old mechanism if you notice compatibility issues. The default value is false.

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

    Version

    Gets the version number of this engine. The version is increased each time the engine (or any container schema descriptor) was modified.

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

    VersionInfo

    Gets the value of assembly version of the GridGroupingControl at the time it was dropped onto a form with designer.

    Declaration
    public virtual string VersionInfo { get; }
    Property Value
    Type Description
    System.String

    Methods

    BumpVersion()

    Increases the Version number of this engine.

    Declaration
    public void BumpVersion()

    CreateAddNewRecord(AddNewRecordSection)

    Creates a new instance of the AddNewRecord class.

    Declaration
    public virtual AddNewRecord CreateAddNewRecord(AddNewRecordSection parent)
    Parameters
    Type Name Description
    AddNewRecordSection parent

    The parent section.

    Returns
    Type Description
    AddNewRecord

    The new element.

    CreateAddNewRecordSection(Group)

    Creates a new instance of the AddNewRecordSection class.

    Declaration
    public virtual AddNewRecordSection CreateAddNewRecordSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    AddNewRecordSection

    The new element.

    CreateCaptionRow(CaptionSection)

    Creates a new instance of the CaptionRow class.

    Declaration
    public virtual CaptionRow CreateCaptionRow(CaptionSection parent)
    Parameters
    Type Name Description
    CaptionSection parent

    The parent section.

    Returns
    Type Description
    CaptionRow

    The new element.

    CreateCaptionSection(Group)

    Creates a new instance of the CaptionSection class.

    Declaration
    public virtual CaptionSection CreateCaptionSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    CaptionSection

    The new element.

    CreateChildTable(Element)

    Creates a new instance of the ChildTable class.

    Declaration
    public virtual ChildTable CreateChildTable(Element parent)
    Parameters
    Type Name Description
    Element parent

    The parent element.

    Returns
    Type Description
    ChildTable

    The new element.

    CreateColumnHeaderRow(ColumnHeaderSection)

    Creates a new instance of the ColumnHeaderRow class.

    Declaration
    public virtual ColumnHeaderRow CreateColumnHeaderRow(ColumnHeaderSection parent)
    Parameters
    Type Name Description
    ColumnHeaderSection parent

    The parent section.

    Returns
    Type Description
    ColumnHeaderRow

    The new element.

    CreateColumnHeaderSection(Group)

    Creates a new instance of the ColumnHeaderSection class.

    Declaration
    public virtual ColumnHeaderSection CreateColumnHeaderSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    ColumnHeaderSection

    The new element.

    CreateEmptySection(Group)

    Creates a new instance of the EmptySection class.

    Declaration
    public virtual EmptySection CreateEmptySection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    EmptySection

    The new element.

    CreateExpressionFieldEvaluator(TableDescriptor)

    Creates a new instance of the ExpressionFieldEvaluator class that is bound to the specified instance of the TableDescriptor class. and provides routines for parsing and evaluating formula expressions in fields.

    Declaration
    public virtual ExpressionFieldEvaluator CreateExpressionFieldEvaluator(TableDescriptor tableDescriptor)
    Parameters
    Type Name Description
    TableDescriptor tableDescriptor

    The TableDescriptor this object is bounded to.

    Returns
    Type Description
    ExpressionFieldEvaluator

    A new instance of the ExpressionFieldEvaluator class.

    CreateFilterBarRow(FilterBarSection)

    Creates a new instance of the FilterBarRow class.

    Declaration
    public virtual FilterBarRow CreateFilterBarRow(FilterBarSection parent)
    Parameters
    Type Name Description
    FilterBarSection parent

    The parent section.

    Returns
    Type Description
    FilterBarRow

    The new element.

    CreateFilterBarSection(Group)

    Creates a new instance of the FilterBarSection class.

    Declaration
    public virtual FilterBarSection CreateFilterBarSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    FilterBarSection

    The new element.

    CreateGroup(Section)

    Creates a new instance of the Group class.

    Declaration
    public virtual Group CreateGroup(Section parent)
    Parameters
    Type Name Description
    Section parent

    The parent section.

    Returns
    Type Description
    Group

    The new element.

    CreateGroupFooterSection(Group)

    Creates a new instance of the GroupFooterSection class.

    Declaration
    public virtual GroupFooterSection CreateGroupFooterSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    GroupFooterSection

    The new element.

    CreateGroupHeaderSection(Group)

    Creates a new instance of the GroupHeaderSection class.

    Declaration
    public virtual GroupHeaderSection CreateGroupHeaderSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    GroupHeaderSection

    The new element.

    CreateGroupPreviewSection(Group)

    Creates a new instance of the GroupPreviewSection class.

    Declaration
    public virtual GroupPreviewSection CreateGroupPreviewSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    GroupPreviewSection

    The new element.

    CreateGroupsDetails(Group)

    Creates a new instance of the GroupsDetails class.

    Declaration
    public virtual GroupsDetails CreateGroupsDetails(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    GroupsDetails

    The new element.

    CreateNestedTable(RecordNestedTablesPart)

    Creates a new instance of the NestedTable class.

    Declaration
    public virtual NestedTable CreateNestedTable(RecordNestedTablesPart parent)
    Parameters
    Type Name Description
    RecordNestedTablesPart parent

    The parent element.

    Returns
    Type Description
    NestedTable

    The new element.

    CreateRecord(Table)

    Creates a new instance of the Record class.

    Declaration
    public virtual Record CreateRecord(Table parentTable)
    Parameters
    Type Name Description
    Table parentTable

    The parent table.

    Returns
    Type Description
    Record

    The new element.

    CreateRecordNestedTablesPart(Record)

    Creates a new instance of the RecordNestedTablesPart class.

    Declaration
    public virtual RecordNestedTablesPart CreateRecordNestedTablesPart(Record parent)
    Parameters
    Type Name Description
    Record parent

    The parent record.

    Returns
    Type Description
    RecordNestedTablesPart

    The new element.

    CreateRecordPreviewRow(RecordPreviewRowsPart)

    Creates a new instance of the RecordPreviewRow class.

    Declaration
    public virtual RecordPreviewRow CreateRecordPreviewRow(RecordPreviewRowsPart parent)
    Parameters
    Type Name Description
    RecordPreviewRowsPart parent

    The parent element.

    Returns
    Type Description
    RecordPreviewRow

    The new element.

    CreateRecordPreviewRowsPart(Record)

    Creates a new instance of the RecordPreviewRowsPart class.

    Declaration
    public virtual RecordPreviewRowsPart CreateRecordPreviewRowsPart(Record parent)
    Parameters
    Type Name Description
    Record parent

    The parent record.

    Returns
    Type Description
    RecordPreviewRowsPart

    The new element.

    CreateRecordRow(RecordRowsPart)

    Creates a new instance of theRecordRow class.

    Declaration
    public virtual RecordRow CreateRecordRow(RecordRowsPart parent)
    Parameters
    Type Name Description
    RecordRowsPart parent

    The parent element.

    Returns
    Type Description
    RecordRow

    The new element.

    CreateRecordRowsPart(Record)

    Creates a new instance of the RecordRowsPart class.

    Declaration
    public virtual RecordRowsPart CreateRecordRowsPart(Record parent)
    Parameters
    Type Name Description
    Record parent

    The parent record.

    Returns
    Type Description
    RecordRowsPart

    The new element.

    CreateRecordsDetails(Group)

    Creates a new instance of the RecordsDetails class.

    Declaration
    public virtual RecordsDetails CreateRecordsDetails(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    RecordsDetails

    The new element.

    CreateRelationDescriptor()

    Creates a new instance of the RelationDescriptor class.

    Declaration
    public virtual RelationDescriptor CreateRelationDescriptor()
    Returns
    Type Description
    RelationDescriptor

    A new instance of the RelationDescriptor class.

    CreateRowElementsSection(Group)

    Creates a new instance of the RowElementsSection class.

    Declaration
    public virtual RowElementsSection CreateRowElementsSection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    RowElementsSection

    The new element.

    CreateSummarySection(Group)

    Creates a new instance of the Section class.

    Declaration
    public virtual Section CreateSummarySection(Group parent)
    Parameters
    Type Name Description
    Group parent

    The parent group.

    Returns
    Type Description
    Section

    The new element.

    CreateTable(TableDescriptor)

    Creates a new instance of the Table class with the specified instance of the TableDescriptor class.

    Declaration
    public Table CreateTable(TableDescriptor tableDescriptor)
    Parameters
    Type Name Description
    TableDescriptor tableDescriptor

    The TableDescriptor with schema information for the table.

    Returns
    Type Description
    Table

    A new Table object.

    CreateTable(TableDescriptor, Table)

    Creates a new instance of the Table class for the specified instance of the TableDescriptor class and parent table.

    Declaration
    public virtual Table CreateTable(TableDescriptor tableDescriptor, Table parentTable)
    Parameters
    Type Name Description
    TableDescriptor tableDescriptor

    The TableDescriptor with schema information for the table.

    Table parentTable

    The parent table that has a relation with this new table.

    Returns
    Type Description
    Table

    A new Table object.

    CreateTableDescriptor(RelationDescriptor)

    Creates a new instance of the TableDescriptor that belongs to the specified instance of the RelationDescriptor class.

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

    The RelationDescriptor that holds this TableDescriptor. If it is NULL, the return TableDescriptor is the main TableDescripor and has no parent relation.

    Returns
    Type Description
    TableDescriptor

    A new TableDescriptor object.

    Dispose(Boolean)

    Overridden to manage the unwanted resources.

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

    EnumerateTableDescriptor()

    Creates a new instance of the EngineTableDescriptorEnumerable class.

    Declaration
    public EngineTableDescriptorEnumerable EnumerateTableDescriptor()
    Returns
    Type Description
    EngineTableDescriptorEnumerable

    A EngineTableDescriptorEnumerable object.

    EnumerateTables()

    Creates a new instance of the EngineTableEnumerable class.

    Declaration
    public EngineTableEnumerable EnumerateTables()
    Returns
    Type Description
    EngineTableEnumerable

    A EngineTableEnumerable object.

    GetDesignMode()

    Determines whether the engine is attached to a component or control that is currently being designed in the Visual Studio designer.

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

    True if the engine is attached to the control being designed; Otherwise False.

    GetName()

    Overridden to get the table descriptor name.

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

    Table descriptor name.

    Overrides
    DescriptorBase.GetName()

    GetSourceList()

    Gets a source list previously specified with SetSourceList(IEnumerable). If no source list was specified or if ShouldReplaceSourceList() returns True, the virtual GetSourceListBase() method is called and the resulting source list will then be passed as argument to a SetSourceList(IEnumerable) method call.

    Declaration
    public IEnumerable GetSourceList()
    Returns
    Type Description
    System.Collections.IEnumerable

    The source list for this engine.

    Remarks

    The reasoning for the way the GetSourceListBase(), GetSourceList(), SetSourceList(IEnumerable), and ShouldReplaceSourceList() methods work together is to delay initializing the source list until all information has been specified to correctly locate the list. This allows the end user to set DataSource and DataMember properties without having to worry about the order when the properties are set. It will also ensure that with Windows Forms applications, the currency manager context has been initialized.

    GetSourceListBase()

    Occurs when there has previously been no data source specified and a GetSourceList() call occurs. Override this method to allow retrieving the source list on demand.

    Declaration
    protected virtual IEnumerable GetSourceListBase()
    Returns
    Type Description
    System.Collections.IEnumerable

    The source list for this engine.

    Remarks

    With a GridGroupingControl, the GridEngineBase method overloads this method to bind the engine to a data source on demand. When this method is called, GridEngineBase will locate a CurrencyManager based on the given DataSource and DataMember properties. The resulting source list will then be passed as an argument to a SetSourceList(IEnumerable) method call.

    The reasoning for the way the GetSourceListBase(), GetSourceList(), SetSourceList(IEnumerable), and ShouldReplaceSourceList() methods work together is to delay initializing the source list until all information has been specified to correctly locate the list. This allows the end user to set DataSource and DataMember properties without having to worry about the order when the properties are set. It will also ensure that with Windows Forms applications, the currency manager context has been initialized.

    GetTableDescriptor(String)

    Gets the main table descriptor or a table descriptor of any nested relation that matches the specified name.

    Declaration
    public TableDescriptor GetTableDescriptor(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the table descriptor to search.

    Returns
    Type Description
    TableDescriptor

    The table descriptor or NULL if not found.

    HasSourceList()

    Determines whether the SetSourceList(IEnumerable) was called and source list has been set or not.

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

    True if SetSourceList(IEnumerable) was called and source list has been set; False otherwise.

    InitializeFrom(Engine)

    Initializes an 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(Engine other)
    Parameters
    Type Name Description
    Engine other

    The source object.

    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)

    Raises the ExceptionRaised event.

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

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

    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 contains the event data.

    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 when the PropertyChanging event is done.

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

    A DescriptorPropertyChangedEventArgs that contains the event data.

    OnQueryAddRelation(QueryAddRelationEventArgs)

    Occurs when the QueryAddRelation event is done.

    Declaration
    protected virtual void OnQueryAddRelation(QueryAddRelationEventArgs e)
    Parameters
    Type Name Description
    QueryAddRelationEventArgs e

    A QueryAddRelationEventArgs contains the event data.

    OnQueryRecordMeetsFilterCriteria(QueryRecordMeetsFilterCriteriaEventArgs)

    Raises the QueryRecordMeetsFilterCriteria event.

    Declaration
    protected virtual void OnQueryRecordMeetsFilterCriteria(QueryRecordMeetsFilterCriteriaEventArgs e)
    Parameters
    Type Name Description
    QueryRecordMeetsFilterCriteriaEventArgs e

    A QueryRecordMeetsFilterCriteriaEventArgs that contains the event data.

    OnQueryShowField(QueryShowFieldEventArgs)

    Occurs when the QueryShowField event is done.

    Declaration
    protected virtual void OnQueryShowField(QueryShowFieldEventArgs e)
    Parameters
    Type Name Description
    QueryShowFieldEventArgs e

    A QueryShowFieldEventArgs contains the event data.

    OnQueryShowNestedPropertiesFields(QueryShowNestedPropertiesFieldsEventArgs)

    Raises the QueryShowNestedPropertiesFields event is done.

    Declaration
    protected virtual void OnQueryShowNestedPropertiesFields(QueryShowNestedPropertiesFieldsEventArgs e)
    Parameters
    Type Name Description
    QueryShowNestedPropertiesFieldsEventArgs e

    A QueryShowNestedPropertiesFieldsEventArgs contains the event data.

    OnQueryShowRelationDisplayFields(QueryShowRelationFieldsEventArgs)

    Occurs when the QueryShowRelationDisplayFields event is done.

    Declaration
    protected virtual void OnQueryShowRelationDisplayFields(QueryShowRelationFieldsEventArgs e)
    Parameters
    Type Name Description
    QueryShowRelationFieldsEventArgs e

    A QueryShowRelationFieldsEventArgs 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 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 RecordValueChangingEventArgs 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 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 contains the event data.

    OnSourceListChanged(EventArgs)

    Occurs when the SourceListChanged event is done.

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

    An System.EventArgs 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.

    OnTableCreated(EventArgs)

    Occurs when the TableCreated event is done.

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

    An System.EventArgs contains the event data.

    OnTableDescriptorCreated(EventArgs)

    Occurs when the TableDescriptorCreated event is done.

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

    An System.EventArgs contains the event data.

    OnTableSourceListChanged(TableEventArgs)

    Occurs when the SourceListChanged event is done.

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

    A TableEventArgs that contains the event data.

    RaiseQueryAddRelation(QueryAddRelationEventArgs)

    Occurs when the QueryAddRelation event is done.

    Declaration
    public void RaiseQueryAddRelation(QueryAddRelationEventArgs e)
    Parameters
    Type Name Description
    QueryAddRelationEventArgs e

    A QueryAddRelationEventArgs contains the event data.

    RaiseQueryShowField(QueryShowFieldEventArgs)

    Occurs when the QueryShowField event is done.

    Declaration
    public void RaiseQueryShowField(QueryShowFieldEventArgs e)
    Parameters
    Type Name Description
    QueryShowFieldEventArgs e

    A QueryShowFieldEventArgs contains the event data.

    RaiseQueryShowNestedPropertiesFields(QueryShowNestedPropertiesFieldsEventArgs)

    Occurs when the QueryShowNestedPropertiesFields event is done.

    Declaration
    public void RaiseQueryShowNestedPropertiesFields(QueryShowNestedPropertiesFieldsEventArgs e)
    Parameters
    Type Name Description
    QueryShowNestedPropertiesFieldsEventArgs e

    A QueryShowNestedPropertiesFieldsEventArgs contains the event data.

    RaiseQueryShowRelationDisplayFields(QueryShowRelationFieldsEventArgs)

    Occurs when the QueryShowRelationDisplayFields event is done.

    Declaration
    public void RaiseQueryShowRelationDisplayFields(QueryShowRelationFieldsEventArgs e)
    Parameters
    Type Name Description
    QueryShowRelationFieldsEventArgs e

    A QueryShowRelationFieldsEventArgs 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 the event data.

    Reset()

    Overridden to reset the values.

    Declaration
    public override void Reset()
    Overrides
    DescriptorBase.Reset()

    ResetCacheRecordValues()

    Resets the CacheRecordValues back to its default value.

    Declaration
    public void ResetCacheRecordValues()

    ResetCultureInfo()

    Resets the System.Globalization.CultureInfo property.

    Declaration
    public void ResetCultureInfo()

    ResetEnableAutoSize()

    Resets the EnableAutoSize property.

    Declaration
    public void ResetEnableAutoSize()

    ResetMaxNestedCollectionRecurseLevel()

    Resets the MaxNestedCollectionRecurseLevel property back to its default value AbortNestedCollectionsRecursionLevel

    Declaration
    public void ResetMaxNestedCollectionRecurseLevel()

    ResetMaxNestedFieldRecurseLevel()

    Resets the MaxNestedFieldRecurseLevel property back to its default value AbortNestedFieldsRecursionLevel

    Declaration
    public void ResetMaxNestedFieldRecurseLevel()

    ResetTable()

    Resets the table.

    Declaration
    public void ResetTable()

    ResetTableDescriptor()

    Resets the TableDescriptor back to its default state and auto-populates schema information on demand.

    Declaration
    public void ResetTableDescriptor()

    ResetTableDirtyOnSourceListReset()

    Resets the TableDirtyOnSourceListReset back to its default value.

    Declaration
    public void ResetTableDirtyOnSourceListReset()

    ResetUseLazyUniformChildListRelation()

    Resets the UseLazyUniformChildListRelation property.

    Declaration
    public void ResetUseLazyUniformChildListRelation()

    ResetUseOldListChangedHandler()

    Resets the UseOldListChangedHandler property.

    Declaration
    public void ResetUseOldListChangedHandler()

    ResetUseOldUniformChildListRelation()

    Resets the UseOldUniformChildListRelation property.

    Declaration
    public void ResetUseOldUniformChildListRelation()

    SetSourceList(IEnumerable)

    Initializes the source list for the engine.

    Declaration
    public void SetSourceList(IEnumerable value)
    Parameters
    Type Name Description
    System.Collections.IEnumerable value

    The new source list for the engine.

    Remarks

    If the passed in source list is the same as a previous SetSourceList(IEnumerable) call, the method will return without change to avoid duplicate initialization of the same list.

    The Table will be reinitialized and the SetItemProperties(Object) of the TableDescriptor is called. A SourceListChanged event is raised.

    ShouldReplaceSourceList()

    Determines whether the SourceList should be reinitialized or not when next time GetSourceList() is called.

    Declaration
    protected virtual bool ShouldReplaceSourceList()
    Returns
    Type Description
    System.Boolean

    True if the SourceList should be reinitialized the next time GetSourceList() is called; False if not.

    Remarks

    With a GridGroupingControl, the GridEngineBase method overloads this method and returns True if either the DataSource or DataMember property was changed.

    The reasoning for the way the GetSourceListBase(), GetSourceList(), SetSourceList(IEnumerable), and ShouldReplaceSourceList() methods work together is to delay initializing the source list until all information has been specified to correctly locate the list. This allows the end user to set DataSource and DataMember properties without having to worry about the order when the properties are set. It will also ensure that with Windows Forms applications, the currency manager context has been initialized.

    ShouldSerializeCacheRecordValues()

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

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

    True if CacheRecordValues was manually modified; Otherwise False.

    ShouldSerializeCultureInfo()

    Determines whether Culture has been modified and its value should be serialized or not.

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

    True if the content is changed; Otherwise False.

    ShouldSerializeEnableAutoSize()

    Determines whether EnableAutoSize has been modified and its value should be serialized or not.

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

    True if the content is changed; Otherwise False.

    ShouldSerializeMaxNestedCollectionRecurseLevel()

    Determines whether MaxNestedCollectionRecurseLevel has been modified and its value should be serialized at design-time.

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

    true if contents were changed; false otherwise.

    ShouldSerializeMaxNestedFieldRecurseLevel()

    Determines whether the MaxNestedFieldRecurseLevel has been modified or not. and its value should be serialized at design-time.

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

    True if contents were changed; Otherwise False.

    ShouldSerializeTable()

    Determines whether the Table object was created or not.

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

    True if the Table object was created; False if it is NULL

    ShouldSerializeTableDescriptor()

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

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

    True if TableDescriptor was manually modified; False if it only contains auto-populated data.

    ShouldSerializeTableDirtyOnSourceListReset()

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

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

    True if TableDirtyOnSourceListReset was manually modified;

    ShouldSerializeUseLazyUniformChildListRelation()

    Determines whether UseLazyUniformChildListRelation has been modified or not and its value should be serialized.

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

    True if the content is changed; Otherwise False.

    ShouldSerializeUseOldListChangedHandler()

    Determines whether UseOldListChangedHandler has been modified or not and its value should be serialized.

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

    True if the content is changed; Otherwise False.

    ShouldSerializeUseOldUniformChildListRelation()

    Determines whether the UseOldUniformChildListRelation has been modified or not and its value should be serialized.

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

    True if the content is changed; Otherwise False.

    ToString()

    Overridden to get the string representation of the engine.

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

    String representation of the current object.

    Overrides
    DescriptorBase.ToString()

    UnwireSourceList()

    Unwire the source list.

    Declaration
    protected virtual void UnwireSourceList()

    WireSourceList()

    Wires the source list.

    Declaration
    protected virtual void WireSourceList()

    Events

    CategorizedRecords

    Occurs after records are categorized when a table is marked dirty (TableDirty).

    Declaration
    public event TableEventHandler CategorizedRecords
    Event Type
    Type Description
    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 is marked dirty (TableDirty).

    Declaration
    public event TableEventHandler CategorizingRecords
    Event Type
    Type Description
    TableEventHandler
    Remarks

    When TableDirty is set to 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 was changed. Check the Action of the CurrentRecordContextChangeEventArgs to get information which current record state was changed.

    Declaration
    public event CurrentRecordContextChangeEventHandler CurrentRecordContextChange
    Event Type
    Type Description
    CurrentRecordContextChangeEventHandler

    CurrentRecordManagerReset

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

    Declaration
    public event TableEventHandler CurrentRecordManagerReset
    Event Type
    Type Description
    TableEventHandler
    Remarks

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

    DisplayElementChanged

    When number of visible elements are changed.

    Declaration
    public event DisplayElementChangedEventHandler DisplayElementChanged
    Event Type
    Type Description
    DisplayElementChangedEventHandler

    DisplayElementChanging

    When number of visible elements are changed.

    Declaration
    public event DisplayElementChangingEventHandler DisplayElementChanging
    Event Type
    Type Description
    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 Description
    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 is categorized and when a record is changed. The event does not occur during categorization of the table. See the CategorizedRecords elements to when categorization finishes.

    Declaration
    public event GroupEventHandler GroupAdded
    Event Type
    Type Description
    GroupEventHandler

    GroupCollapsed

    Occurs after a group is collapsed.

    Declaration
    public event GroupEventHandler GroupCollapsed
    Event Type
    Type Description
    GroupEventHandler

    GroupCollapsing

    Occurs before a group is collapsed.

    Declaration
    public event GroupEventHandler GroupCollapsing
    Event Type
    Type Description
    GroupEventHandler

    GroupExpanded

    Occurs after a group is expanded.

    Declaration
    public event GroupEventHandler GroupExpanded
    Event Type
    Type Description
    GroupEventHandler

    GroupExpanding

    Occurs before a group is expanded.

    Declaration
    public event GroupEventHandler GroupExpanding
    Event Type
    Type Description
    GroupEventHandler

    GroupRemoving

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

    Declaration
    public event GroupEventHandler GroupRemoving
    Event Type
    Type Description
    GroupEventHandler

    GroupSummaryInvalidated

    Occurs when a summary has been marked dirty.

    Declaration
    public event GroupEventHandler GroupSummaryInvalidated
    Event Type
    Type Description
    GroupEventHandler
    Remarks

    The GridGroupingControl listens to this event and forces a repaint of the specified summary if it is visible when this event was 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 Description
    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 Description
    TableEventHandler

    PropertyChanged

    Occurs when a property is changed.

    Declaration
    public event DescriptorPropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    DescriptorPropertyChangedEventHandler

    PropertyChanging

    Occurs before a property is changed.

    Declaration
    public event DescriptorPropertyChangedEventHandler PropertyChanging
    Event Type
    Type Description
    DescriptorPropertyChangedEventHandler

    QueryAddRelation

    This event affects the auto-population of the RelationDescriptorCollection.

    It is called for each relation and lets you control at run-time if the relation should be added to the RelationDescriptorCollection. You can set e.Cancel = True to avoid specific relations being added.

    Declaration
    public event QueryAddRelationEventHandler QueryAddRelation
    Event Type
    Type Description
    QueryAddRelationEventHandler

    QueryRecordMeetsFilterCriteria

    Occurs when a record is checked whether it meets filter criteria and should appear visible in the tables DisplayElements.

    Declaration
    public event QueryRecordMeetsFilterCriteriaEventHandler QueryRecordMeetsFilterCriteria
    Event Type
    Type Description
    QueryRecordMeetsFilterCriteriaEventHandler

    QueryShowField

    This event affects the auto-population of the FieldDescriptorCollection.

    It is called for each field and lets you control at run-time if a specific field should be added to the FieldDescriptorCollection. You can set e.Cancel = True to avoid specific fields being added.

    Declaration
    public event QueryShowFieldEventHandler QueryShowField
    Event Type
    Type Description
    QueryShowFieldEventHandler

    QueryShowNestedPropertiesFields

    This event affects the auto-population of the FieldDescriptorCollection.

    It lets you control at run-time if individual fields should be added for every property of a type when a type has nested properties. You can set e.Cancel = true to avoid nested fields being generated for a specific type.

    Declaration
    public event QueryShowNestedPropertiesFieldsEventHandler QueryShowNestedPropertiesFields
    Event Type
    Type Description
    QueryShowNestedPropertiesFieldsEventHandler

    QueryShowRelationDisplayFields

    This event affects the auto-population of the FieldDescriptorCollection.

    It is called for each foreign key relation and lets you control at run-time if the related fields of the child table should be added to the FieldDescriptorCollection. You can set e.Cancel = True to avoid specific fields being added.

    Declaration
    public event QueryShowRelationFieldsEventHandler QueryShowRelationDisplayFields
    Event Type
    Type Description
    QueryShowRelationFieldsEventHandler

    QueryValue

    Occurs when a value for a field descriptor and record is returned. See the Grid.Grouping\Samples\CustomSummary. sample how to use this event with unbound field descriptors.

    Declaration
    public event FieldValueEventHandler QueryValue
    Event Type
    Type Description
    FieldValueEventHandler

    RecordCollapsed

    Occurs after a record with nested tables is collapsed.

    Declaration
    public event RecordEventHandler RecordCollapsed
    Event Type
    Type Description
    RecordEventHandler

    RecordCollapsing

    Occurs before a record with nested tables is collapsed.

    Declaration
    public event RecordEventHandler RecordCollapsing
    Event Type
    Type Description
    RecordEventHandler

    RecordDeleted

    Occurs after a record is deleted.

    Declaration
    public event RecordEventHandler RecordDeleted
    Event Type
    Type Description
    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 Description
    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 Description
    RecordEventHandler

    RecordExpanding

    Occurs before a record with nested tables is expanded.

    Declaration
    public event RecordEventHandler RecordExpanding
    Event Type
    Type Description
    RecordEventHandler

    RecordValueChanged

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

    Declaration
    public event RecordValueChangedEventHandler RecordValueChanged
    Event Type
    Type Description
    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 Description
    RecordValueChangingEventHandler

    SaveValue

    Occurs when values for a field descriptor and record are saved. See the Grid.Grouping\Samples\CustomSummary. sample how to use this event with unbound field descriptors.

    Declaration
    public event FieldValueEventHandler SaveValue
    Event Type
    Type Description
    FieldValueEventHandler

    SelectedRecordsChanged

    Occurs after the SelectedRecords collection was modified.

    Declaration
    public event SelectedRecordsChangedEventHandler SelectedRecordsChanged
    Event Type
    Type Description
    SelectedRecordsChangedEventHandler

    SelectedRecordsChanging

    Occurs after the SelectedRecords collection was modified.

    Declaration
    public event SelectedRecordsChangedEventHandler SelectedRecordsChanging
    Event Type
    Type Description
    SelectedRecordsChangedEventHandler

    SortedItemsInGroup

    Occurs after the records for a group are sorted.

    Declaration
    public event GroupEventHandler SortedItemsInGroup
    Event Type
    Type Description
    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 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 Description
    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 cases 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.

    SourceListChanged

    Occurs after the main data source was replaced with a SetSourceList(IEnumerable) method call.

    Declaration
    public event EventHandler SourceListChanged
    Event Type
    Type Description
    System.EventHandler
    Remarks

    With a GridGroupingControl when you set the data source and data member, the SetSourceList(IEnumerable) method will be called on demand the first time data or schema information needs to be retrieved.

    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 Description
    TableListChangedEventHandler
    Remarks

    The reason for firing this event is to give a programmer the chance to react to a 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.ComponentModelIBindingList.ListChanged event of an attached source list.

    Declaration
    public event TableListChangedEventHandler SourceListListChangedCompleted
    Event Type
    Type Description
    TableListChangedEventHandler
    Remarks

    The reason for firing this event is to give a programmer the chance to react to a 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 data source is added, removed, or changed and after the Table is updated with that change.

    Declaration
    public event RecordChangedEventHandler SourceListRecordChanged
    Event Type
    Type Description
    RecordChangedEventHandler

    SourceListRecordChanging

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

    Declaration
    public event RecordChangedEventHandler SourceListRecordChanging
    Event Type
    Type Description
    RecordChangedEventHandler

    TableCreated

    Occurs after the Table object is created.

    Declaration
    public event EventHandler TableCreated
    Event Type
    Type Description
    System.EventHandler

    TableDescriptorCreated

    Occurs after the TableDescriptor object is created.

    Declaration
    public event EventHandler TableDescriptorCreated
    Event Type
    Type Description
    System.EventHandler

    TableSourceListChanged

    Occurs after the data-source is replaced.

    Declaration
    public event TableEventHandler TableSourceListChanged
    Event Type
    Type Description
    TableEventHandler

    Explicit Interface Implementations

    ITableEventsTarget.OnCategorizedRecords(TableEventArgs)

    Occurs when the record are categorized.

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

    A TableEventArgs contains the event data.

    ITableEventsTarget.OnCategorizingRecords(TableEventArgs)

    Occurs when the records are categorizing.

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

    A TableEventArgs contains the event data.

    ITableEventsTarget.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

    Occur when the current record context changed.

    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 manger gets reset.

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

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

    A DisplayElementChangedEventArgs contains the event data.

    ITableEventsTarget.OnDisplayElementChanging(DisplayElementChangingEventArgs)

    Occurs when the display element is getting change.

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

    A DisplayElementChangingEventArgs 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)

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

    ITableEventsTarget.OnGroupCollapsed(GroupEventArgs)

    Occurs when the group is 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 is collapsing.

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

    The 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 is 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 group gets 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 reset.

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

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

    A TableEventArgs contains the event data.

    ITableEventsTarget.OnInvalidatingSummaries(TableEventArgs)

    Occurs when the summary getting reset.

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

    A TableEventArgs contains the event data.

    ITableEventsTarget.OnRecordCollapsed(RecordEventArgs)

    Occurs when the record is collapsed.

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

    The RecordEventArgs contains the event data.

    ITableEventsTarget.OnRecordCollapsing(RecordEventArgs)

    Occurs when the record is 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

    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 record is 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 record is 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

    A RecordValueChangingEventArgs contains the event data.

    ITableEventsTarget.OnRecordValueChanging(RecordValueChangingEventArgs)

    Occurs when the record value is changing.

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

    A RecordValueChangingEventArgs contains the event data.

    ITableEventsTarget.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)

    Occurs when the selected records changed.

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

    A SelectedRecordsChangedEventArgs contains the event data.

    ITableEventsTarget.OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)

    Occurs when the selected records getting change.

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

    A SelectedRecordsChangedEventArgs contains the event data.

    ITableEventsTarget.OnSortedItemsInGroup(GroupEventArgs)

    Occurs when the items in the group gets sorted.

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

    A GroupEventArgs contains the event data.

    ITableEventsTarget.OnSortingItemsInGroup(GroupEventArgs)

    Occurs when the items in the group gets sorting.

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

    A GroupEventArgs contains the event data.

    ITableEventsTarget.OnSourceListListChanged(TableListChangedEventArgs)

    Raises when the source list is 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 change gets 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 source list record 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 changing.

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

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

    A TableEventArgs that contains the event data.

    Implements

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