Class GridTableModel
Represents a grid model that displays rows with DisplayElements of a GridTable and allows grouping, filtering, editing, deleting, and adding of records.
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridTableModel : GridModel, IGridVolatileDataContainer, IOperationFeedbackProvider, ICreateControl, IGridModelSource, ISerializable, IDisposable, IDeserializationCallback, ITableEventsTarget
Constructors
GridTableModel()
Initializes a new instance of the GridTableModel class.
Declaration
public GridTableModel()
Properties
CurrentCellInfo
Gets or sets the value of the current cell information.
Declaration
public override GridCurrentCellInfo CurrentCellInfo { get; set; }
Property Value
| Type |
|---|
| GridCurrentCellInfo |
Overrides
EnableLegacyStyle
Gets or sets a value indicating whether to enable or disable the Legacy styles.
Declaration
public override bool EnableLegacyStyle { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Overrides
FilteredChildTable
Gets or sets the ChildTable for the filtered child table. with this model.
Declaration
public ChildTable FilteredChildTable { get; set; }
Property Value
| Type |
|---|
| ChildTable |
ForwardTableEvents
Gets or sets a object that handles events raised by the Table object.
Declaration
public ITableEventsTarget ForwardTableEvents { get; set; }
Property Value
| Type |
|---|
| ITableEventsTarget |
GroupDropAlign
Gets or sets the enum value of GridGroupDropAreaAlignment.
Declaration
public GridGroupDropAreaAlignment GroupDropAlign { get; set; }
Property Value
| Type |
|---|
| GridGroupDropAreaAlignment |
GroupDropAreaModel
Gets the value of the instance of GridGroupDropAreaModel to the GridGroupingControl control.
Declaration
public GridGroupDropAreaModel GroupDropAreaModel { get; }
Property Value
| Type |
|---|
| GridGroupDropAreaModel |
GroupingControl
Gets the value of the instance of the GridGroupingControl that holds information of the control.
Declaration
public GridGroupingControl GroupingControl { get; }
Property Value
| Type |
|---|
| GridGroupingControl |
HasTable
Gets a value indicating whether the current object contains a GridTable or not.
Declaration
public bool HasTable { get; }
Property Value
| Type |
|---|
| System.Boolean |
InSetTable
Gets or sets a value indicating whether the property Table is set or not.
Declaration
public bool InSetTable { get; }
Property Value
| Type |
|---|
| System.Boolean |
InTableChanged
Gets a value indicating whether the TableChanged event is triggered or not.
Declaration
public bool InTableChanged { get; }
Property Value
| Type |
|---|
| System.Boolean |
Item[Int32, Int32]
Gets or sets the values of GridTableCellStyleInfo of a cell.
Declaration
public GridTableCellStyleInfo this[int rowIndex, int colIndex] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | |
| System.Int32 | colIndex |
Property Value
| Type |
|---|
| GridTableCellStyleInfo |
SelectedRanges
Gets the selected ranges in the grid. Used internally.
Declaration
public override GridRangeInfoList SelectedRanges { get; }
Property Value
| Type |
|---|
| GridRangeInfoList |
Overrides
SurgeColWidthForFilterIcon
Gets or sets a value indicating whether to increase the size of column width for filter icon or not.
Declaration
public bool SurgeColWidthForFilterIcon { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Remarks
This property increases the column width by 15 when it is true.
Table
Gets or sets the value of GridTable with display elements to be displayed in the grid.
Declaration
public GridTable Table { get; set; }
Property Value
| Type |
|---|
| GridTable |
Methods
ColIndexToField(Int32)
Converts the given column index to a zero-based number adjusted for column headers collection.
Declaration
public int ColIndexToField(int colIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | colIndex | The column index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The field index of the specified column. |
CreateGroupDropAreaModel()
Creates an instance of the GridGroupDropAreaModel class.
Declaration
public virtual GridGroupDropAreaModel CreateGroupDropAreaModel()
Returns
| Type | Description |
|---|---|
| GridGroupDropAreaModel | A new instance of the GridGroupDropAreaModel class. |
Dispose(Boolean)
Overrides and manages the unwanted resources.
Declaration
protected override void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing | If True the object is being disposing. Otherwise False. |
Overrides
FieldToColIndex(Int32)
Converts a zero-based number to a column index in a grid adjusted for column headers (adding GetColumnIndentCount()).
Declaration
public int FieldToColIndex(int fieldNum)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | fieldNum | A zero-based field number. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The column index in the grid. |
GetCaptionColIndex(Element)
Gets the column index where the caption bar of a group should be drawn with the specified element.
Declaration
public int GetCaptionColIndex(Element el)
Parameters
| Type | Name | Description |
|---|---|---|
| Element | el | The element. |
Returns
| Type | Description |
|---|---|
| System.Int32 | If the element is not a CaptionRow, one is returned; otherwise the column index where the caption bar should be drawn. |
GetColumnDescriptorAt(GridRangeInfo)
Gets the GridColumnDescriptor displayed at the specified cell if it is a header or record field cell.
Declaration
public GridColumnDescriptor GetColumnDescriptorAt(GridRangeInfo cell)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRangeInfo | cell | The row and column index. |
Returns
| Type | Description |
|---|---|
| GridColumnDescriptor | The GridColumnDescriptor displayed at the specified cell if it is a header or record field cell; NULL otherwise. |
GetColumnDescriptorAt(Int32, Int32)
Gets the GridColumnDescriptor displayed at the specified cell if it is a header or record field cell.
Declaration
public GridColumnDescriptor GetColumnDescriptorAt(int rowIndex, int colIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
Returns
| Type | Description |
|---|---|
| GridColumnDescriptor | The GridColumnDescriptor displayed at the specified cell if it is a header or record field cell; NULL otherwise. |
GetColumnIndentCount()
Gets the number of indent columns.
Declaration
public int GetColumnIndentCount()
Returns
| Type | Description |
|---|---|
| System.Int32 | If records don't have nested tables, the method returns GroupedColumns.Count+1; otherwise GroupedColumns.Count+2. |
GetDisplayElementAt(Int32)
Gets the display element at the specified row index. Use Table.DisplayElements[rowIndex]
Declaration
public Element GetDisplayElementAt(int rowIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
Returns
| Type | Description |
|---|---|
| Element | The element at the specified row index. |
GetDisplayElementCount()
Gets the display element counts. Use Table.DisplayElements.Count
Declaration
public int GetDisplayElementCount()
Returns
| Type | Description |
|---|---|
| System.Int32 | Number of display elements. |
GetDisplayElementIndexOf(Element)
Gets the index of the display element. Use Table.DisplayElements.IndexOf
Declaration
public int GetDisplayElementIndexOf(Element el)
Parameters
| Type | Name | Description |
|---|---|---|
| Element | el | The element to be identified. |
Returns
| Type | Description |
|---|---|
| System.Int32 | If found, index of the given element; Otherwise -1. |
GetFixedLineBorder()
Overrides and gets the GridBorder object based on TableOptions.GridLineBorder. If its style is set to GridBorderStyle.Standard the default properties Options.DefaultGridBorderStyle and Properties.FixedLineColor will be used.
Declaration
public override GridBorder GetFixedLineBorder()
Returns
| Type | Description |
|---|---|
| GridBorder | Fixed line border. |
Overrides
GetGridLineBorder()
Overrides and gets the GridBorder object based on TableOptions.GridLineBorder. If its style is set to GridBorderStyle.Standard the default properties Options.DefaultGridBorderStyle and Properties.GridLineColor will be used.
Declaration
public override GridBorder GetGridLineBorder()
Returns
| Type | Description |
|---|---|
| GridBorder | The Grid line border. |
Overrides
GetHeaderColumnDescriptorAt(GridRangeInfo)
Gets the GridColumnDescriptor displayed at the specified cell if it is a header cell.
Declaration
public GridColumnDescriptor GetHeaderColumnDescriptorAt(GridRangeInfo cell)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRangeInfo | cell | The current cell identified from the row and column index. |
Returns
| Type | Description |
|---|---|
| GridColumnDescriptor | The GridColumnDescriptor displayed at the specified cell if it is a header cell; NULL otherwise. |
GetHeaderColumnDescriptorAt(Int32)
Gets the GridColumnDescriptor displayed at the specified column index in the top-most row.
Declaration
public GridColumnDescriptor GetHeaderColumnDescriptorAt(int colIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | colIndex | The column index. |
Returns
| Type | Description |
|---|---|
| GridColumnDescriptor | The GridColumnDescriptor displayed at the specified column if it is a header cell; NULL otherwise. |
GetHeaderColumnDescriptorAt(Int32, Int32)
Gets the GridColumnDescriptor displayed at the specified row and column index if it is a header cell.
Declaration
public GridColumnDescriptor GetHeaderColumnDescriptorAt(int rowIndex, int colIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | rowIndex | The row index. |
| System.Int32 | colIndex | The column index. |
Returns
| Type | Description |
|---|---|
| GridColumnDescriptor | The GridColumnDescriptor displayed at the specified cell if it is a header cell; NULL otherwise. |
GetRowHeaderRange(Element)
Gets the instance of the GridRangeInfo that spans the cells where a row header for the specified element should be displayed. Can span multiple rows if a table has multiple rows per record.
Declaration
public GridRangeInfo GetRowHeaderRange(Element element)
Parameters
| Type | Name | Description |
|---|---|---|
| Element | element | The display element. |
Returns
| Type | Description |
|---|---|
| GridRangeInfo | The cell range. |
GetStyleDataSource(GridStyleInfo)
Overrides and gets the datasource of the specified style.
Declaration
public override object GetStyleDataSource(GridStyleInfo style)
Parameters
| Type | Name | Description |
|---|---|---|
| GridStyleInfo | style | An instance of the GridStyleInfo class that holds the values of style properties. |
Returns
| Type | Description |
|---|---|
| System.Object | The Datasource. |
Overrides
NameToColIndex(String)
Overrides and gets the column index for a column that matches a given name.
Declaration
public override int NameToColIndex(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the field to be matched. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The column index in the grid; -1 if not found. |
Overrides
Remarks
This function only searches the columns in the root level. If you have several relations displayed in the grid, the nested relations will not be searched by this function.
NameToField(String)
Converts the specified string value of the column to a zero-based index for a column. The resulting number can be used as an index to look up a GridColumnDescriptor in the Columns collection.
Declaration
public int NameToField(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the column to be matched. |
Returns
| Type | Description |
|---|---|
| System.Int32 | A zero-based field number in the Columns collection; -1 if not found. |
NameToRowIndex(String)
Gets the row index for a row that matches a given name.
Declaration
public override int NameToRowIndex(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the row to be matched. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The row index in the grid; -1 if not found. |
Overrides
OnCategorizedRecords(TableEventArgs)
Raises 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)
Triggered 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. |
OnClearingCells(GridClearingCellsEventArgs)
Overrides and raises the ClearingCells event.
Declaration
protected override void OnClearingCells(GridClearingCellsEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridClearingCellsEventArgs | e | The GridClearingCellsEventArgs contains the event data. |
Overrides
OnClipboardCanCopy(GridCutPasteEventArgs)
Overrides and raises the ClipboardCanCopy event.
Declaration
protected override void OnClipboardCanCopy(GridCutPasteEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridCutPasteEventArgs | e | The GridCutPasteEventArgs contains the event data. |
Overrides
OnColsHiding(GridRowColHidingEventArgs)
Overrides and raises the ColsHiding event.
Declaration
protected override void OnColsHiding(GridRowColHidingEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColHidingEventArgs | e | A GridRowColHidingEventArgs that contains the event data. |
Overrides
OnCreatedCutPaste()
Overrides and performs the cut-paste functions.
Declaration
protected override void OnCreatedCutPaste()
Overrides
OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)
Triggered 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)
Triggered 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)
Triggered 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)
Raises 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 | An ExceptionRaisedEventArgs that contains the event data. |
OnGroupAdded(GroupEventArgs)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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. |
OnParseCommonFormats(GridCellTextEventArgs)
Overrides and raises the ParseCommonFormats event.
Declaration
protected override void OnParseCommonFormats(GridCellTextEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridCellTextEventArgs | e | The GridCellTextEventArgs contains the event data. |
Overrides
OnQueryCellFormattedText(GridCellTextEventArgs)
Overrides and raises the QueryCellFormattedText event.
Declaration
protected override void OnQueryCellFormattedText(GridCellTextEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridCellTextEventArgs | e | The GridCellTextEventArgs contains the event data. |
Overrides
OnQueryCellInfo(GridQueryCellInfoEventArgs)
Overrides and raises the QueryCellInfo event.
Declaration
protected override void OnQueryCellInfo(GridQueryCellInfoEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridQueryCellInfoEventArgs | e | The GridQueryCellInfoEventArgs contains the event data. |
Overrides
OnQueryCellText(GridCellTextEventArgs)
Overrides and raises the QueryCellText event.
Declaration
protected override void OnQueryCellText(GridCellTextEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridCellTextEventArgs | e | The GridCellTextEventArgs contains the event data. |
Overrides
OnQueryColCount(GridRowColCountEventArgs)
Overrides and raises the QueryColCount event.
Declaration
protected override void OnQueryColCount(GridRowColCountEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColCountEventArgs | e | The GridRowColCountEventArgs contains the event data. |
Overrides
OnQueryColWidth(GridRowColSizeEventArgs)
Overrides and raises the QueryColWidth event.
Declaration
protected override void OnQueryColWidth(GridRowColSizeEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColSizeEventArgs | e | The GridRowColSizeEventArgs contains the event data. |
Overrides
OnQueryCoveredRange(GridQueryCoveredRangeEventArgs)
Overrides and raises the QueryCoveredRange event.
Declaration
protected override void OnQueryCoveredRange(GridQueryCoveredRangeEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridQueryCoveredRangeEventArgs | e | The GridQueryCoveredRangeEventArgs contains the event data. |
Overrides
OnQueryRowCount(GridRowColCountEventArgs)
Overrides and raises the QueryRowCount event.
Declaration
protected override void OnQueryRowCount(GridRowColCountEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColCountEventArgs | e | The GridRowColCountEventArgs contains the event data. |
Overrides
OnQueryRowHeight(GridRowColSizeEventArgs)
Overrides and raises the QueryRowHeight event.
Declaration
protected override void OnQueryRowHeight(GridRowColSizeEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColSizeEventArgs | e | The GridRowColSizeEventArgs contains the event data. |
Overrides
OnQueryRowHeightTotal(GridRowColSizeTotalEventArgs)
Overrides and raises the QueryRowHeight event.
Declaration
protected override void OnQueryRowHeightTotal(GridRowColSizeTotalEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColSizeTotalEventArgs | e | The GridRowColSizeTotalEventArgs contains the event data. |
Overrides
OnRecordCollapsed(RecordEventArgs)
Triggered 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)
Triggered when the RecordCollapsing event is done.
Declaration
protected virtual void OnRecordCollapsing(RecordEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordEventArgs | e | The RecordEventArgs contains the event data. |
OnRecordDeleted(RecordEventArgs)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered 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. |
OnRowHeightsChanged(GridRowColSizeChangedEventArgs)
Overrides and raises the RowHeightsChanged event.
Declaration
protected override void OnRowHeightsChanged(GridRowColSizeChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColSizeChangedEventArgs | e | The GridRowColSizeChangedEventArgs contains the event data. |
Overrides
OnRowsHiding(GridRowColHidingEventArgs)
Overrides and raises the RowsHiding event.
Declaration
protected override void OnRowsHiding(GridRowColHidingEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColHidingEventArgs | e | The GridRowColHidingEventArgs contains the event data. |
Overrides
OnSaveCellFormattedText(GridCellTextEventArgs)
Overrides and raises the SaveCellFormattedText event.
Declaration
protected override void OnSaveCellFormattedText(GridCellTextEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridCellTextEventArgs | e | The GridCellTextEventArgs contains the event data. |
Overrides
OnSaveCellInfo(GridSaveCellInfoEventArgs)
Overrides and raises the SaveCellInfo event.
Declaration
protected override void OnSaveCellInfo(GridSaveCellInfoEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridSaveCellInfoEventArgs | e | The GridSaveCellInfoEventArgs contains the vent data. |
Overrides
OnSaveCellText(GridCellTextEventArgs)
Overrides and raises the SaveCellText event.
Declaration
protected override void OnSaveCellText(GridCellTextEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridCellTextEventArgs | e | The GridCellTextEventArgs contains the event data. |
Overrides
OnSaveColWidth(GridRowColSizeEventArgs)
Overrides and raises the SaveColWidth event.
Declaration
protected override void OnSaveColWidth(GridRowColSizeEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColSizeEventArgs | e | The GridRowColSizeEventArgs contains the event data. |
Overrides
OnSaveHideRow(GridRowColHideEventArgs)
Overrides and raises the SaveHideRow event.
Declaration
protected override void OnSaveHideRow(GridRowColHideEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColHideEventArgs | e | The GridRowColHideEventArgs contains the event data. |
Overrides
OnSaveRowHeight(GridRowColSizeEventArgs)
Overrides and raises the SaveRowHeight event.
Declaration
protected override void OnSaveRowHeight(GridRowColSizeEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridRowColSizeEventArgs | e | The GridRowColSizeEventArgs contains the event data. |
Overrides
OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)
Raises the SelectedRecordsChanged event.
Declaration
protected virtual void OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| SelectedRecordsChangedEventArgs | e | A SelectedRecordsChangedEventArgs that contains the event data. |
OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)
Raises the SelectedRecordsChanging event.
Declaration
protected virtual void OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| SelectedRecordsChangedEventArgs | e | A SelectedRecordsChangedEventArgs that contains the event data. |
OnSelectionChanging(GridSelectionChangingEventArgs)
Overrides and raises the SelectionChanging event.
Declaration
protected override void OnSelectionChanging(GridSelectionChangingEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GridSelectionChangingEventArgs | e | The GridSelectionChangingEventArgs contains the event data. |
Overrides
OnSortedItemsInGroup(GroupEventArgs)
Triggered 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)
Raises the SortingItemsInGroup event is done.
Declaration
protected virtual void OnSortingItemsInGroup(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | A GroupEventArgs contains the event data. |
OnSourceListListChanged(TableListChangedEventArgs)
Triggered 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)
Triggered 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)
Triggered 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)
Triggered the SourceListRecordChanging event is done.
Declaration
protected virtual void OnSourceListRecordChanging(RecordChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordChangedEventArgs | e | A RecordChangedEventArgs contains the event data. |
OnTableChanged(EventArgs)
Raises the TableChanged event.
Declaration
protected virtual void OnTableChanged(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | The System.EventArgs that contains the event data. |
OnTableChanging(EventArgs)
Raises the TableChanging event.
Declaration
protected virtual void OnTableChanging(EventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.EventArgs | e | The System.EventArgs that contains the event data. |
OnTableSourceListChanged(TableEventArgs)
Triggered 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. |
RecordFieldToRangeInfo(Record, FieldDescriptor)
Gets the instance of the GridRangeInfo that spans the cells where a column should be displayed for a specific record. Can span multiple rows if a table has multiple rows per record or multiple grid columns.
Declaration
public GridRangeInfo RecordFieldToRangeInfo(Record record, FieldDescriptor fd)
Parameters
| Type | Name | Description |
|---|---|---|
| Record | record | The Record. |
| FieldDescriptor | fd | The field descriptor. |
Returns
| Type | Description |
|---|---|
| GridRangeInfo | The cell range. |
RecordFieldToRangeInfo(Record, String)
Gets the instance of the GridRangeInfo that spans the cells where a column should be displayed for a specific record. Can span multiple rows if a table has multiple rows per record or multiple grid columns.
Declaration
public GridRangeInfo RecordFieldToRangeInfo(Record record, string fieldDescriptorName)
Parameters
| Type | Name | Description |
|---|---|---|
| Record | record | The Record. |
| System.String | fieldDescriptorName | The name of the field descriptor (which is GridColumnDescriptor.MappingName). |
Returns
| Type | Description |
|---|---|
| GridRangeInfo | The cell range. |
ToString()
Overrides and returns the string format of the current object.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| System.String | The string representation of the current object. |
UpdateColumnWidths()
Determines if changes were made to the Columns collection or other changes affecting the widths of columns and if necessary, calculates the maximum column width for each column.
Declaration
public bool UpdateColumnWidths()
Returns
| Type | Description |
|---|---|
| System.Boolean | True if column widths were recalculated; False if cache is still good. |
UpdateColumnWidths(Boolean)
Determines if changes were made to the Columns collection or other changes affecting the widths of columns and if necessary, calculates the maximum column width for each column.
Declaration
public bool UpdateColumnWidths(bool force)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | force | If true forces recalculation of column widths. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if column widths were recalculated; False if cache is still good. |
Events
CategorizedRecords
Occurs after records were categorized after a table is 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 Element 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 |
|---|
| TableEventHandler |
Remarks
When TableDirty is set True, e.g. because schema information for a table is changed or because the grouped columns are changed, the table will categorize records on demand the first time information about a record is accessed. At that time, the Element 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 is called.
Declaration
public event TableEventHandler CurrentRecordManagerReset
Event Type
| Type |
|---|
| TableEventHandler |
Remarks
The GridGroupingControl listens to this events and resets any "Current Cell" state when this event is raised.
DisplayElementChanged
When number of visible elements were changed.
Declaration
public event DisplayElementChangedEventHandler DisplayElementChanged
Event Type
| Type |
|---|
| DisplayElementChangedEventHandler |
DisplayElementChanging
When number of visible elements were 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 datasource.
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 to a categorized table after a record is 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 was 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 categorized table after 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 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 |
|---|
| 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 |
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 |
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 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 the cities. 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 SortingItemsInGroup event.
SortingItemsInGroup
Occurs before the records for a group are sorted.
Declaration
public event GroupEventHandler SortingItemsInGroup
Event Type
| Type |
|---|
| GroupEventHandler |
Remarks
The engine has 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 the cities. 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 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 the 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 is added, removed, or changed and after the Table is updated with that change.
Declaration
public event RecordChangedEventHandler SourceListRecordChanged
Event Type
| Type |
|---|
| 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 |
|---|
| RecordChangedEventHandler |
TableChanged
Occurs after the Table is replaced.
Declaration
public event EventHandler TableChanged
Event Type
| Type |
|---|
| System.EventHandler |
TableChanging
Occurs before the Table is being replaced.
Declaration
public event EventHandler TableChanging
Event Type
| Type |
|---|
| System.EventHandler |
TableSourceListChanged
Occurs after the data source was replaced.
Declaration
public event TableEventHandler TableSourceListChanged
Event Type
| Type |
|---|
| TableEventHandler |
Explicit Interface Implementations
ITableEventsTarget.OnCategorizedRecords(TableEventArgs)
Triggered when the CategorizedRecords event is done.
Declaration
void ITableEventsTarget.OnCategorizedRecords(TableEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableEventArgs | e | The TableEventArgs contains the event data. |
ITableEventsTarget.OnCategorizingRecords(TableEventArgs)
Triggered when the CategorizingRecords event is done.
Declaration
void ITableEventsTarget.OnCategorizingRecords(TableEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableEventArgs | e | The TableEventArgs contains the event data. |
ITableEventsTarget.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)
Triggered when the CurrentRecordContextChange event is done.
Declaration
void ITableEventsTarget.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| CurrentRecordContextChangeEventArgs | e | The CurrentRecordContextChangeEventArgs contains the event data. |
ITableEventsTarget.OnCurrentRecordManagerReset(TableEventArgs)
Triggered when the CurrentRecordContextChange event is done.
Declaration
void ITableEventsTarget.OnCurrentRecordManagerReset(TableEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableEventArgs | e | The TableEventArgs contains the event data. |
ITableEventsTarget.OnDisplayElementChanged(DisplayElementChangedEventArgs)
Triggered when the DisplayElementChanged event is done.
Declaration
void ITableEventsTarget.OnDisplayElementChanged(DisplayElementChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| DisplayElementChangedEventArgs | e | The DisplayElementChangedEventArgs contains the event data. |
ITableEventsTarget.OnDisplayElementChanging(DisplayElementChangingEventArgs)
Triggered when the DisplayElementChanging event is done.
Declaration
void ITableEventsTarget.OnDisplayElementChanging(DisplayElementChangingEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| DisplayElementChangingEventArgs | e | The DisplayElementChangingEventArgs event data. |
ITableEventsTarget.OnExceptionRaised(ExceptionRaisedEventArgs)
Triggered when the ExceptionRaised event is done.
Declaration
void ITableEventsTarget.OnExceptionRaised(ExceptionRaisedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| ExceptionRaisedEventArgs | e | The ExceptionRaisedEventArgs contains the event data |
ITableEventsTarget.OnGroupAdded(GroupEventArgs)
Triggered when the GroupAdded is done.
Declaration
void ITableEventsTarget.OnGroupAdded(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs is done. |
ITableEventsTarget.OnGroupCollapsed(GroupEventArgs)
Triggered when the GroupCollapsed event is done.
Declaration
void ITableEventsTarget.OnGroupCollapsed(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs contains the event data. |
ITableEventsTarget.OnGroupCollapsing(GroupEventArgs)
Triggered when the GroupCollapsing event is done.
Declaration
void ITableEventsTarget.OnGroupCollapsing(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs contains the event data. |
ITableEventsTarget.OnGroupExpanded(GroupEventArgs)
Triggered when the GroupExpanded event is done.
Declaration
void ITableEventsTarget.OnGroupExpanded(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs contains the event data. |
ITableEventsTarget.OnGroupExpanding(GroupEventArgs)
Triggered when the GroupExpanding event is done.
Declaration
void ITableEventsTarget.OnGroupExpanding(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs contains the event data. |
ITableEventsTarget.OnGroupRemoving(GroupEventArgs)
Triggered when the GroupRemoving event is done.
Declaration
void ITableEventsTarget.OnGroupRemoving(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs contains the event data. |
ITableEventsTarget.OnGroupSummaryInvalidated(GroupEventArgs)
Triggered when the GroupSummaryInvalidated event is done.
Declaration
void ITableEventsTarget.OnGroupSummaryInvalidated(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs contains the event data. |
ITableEventsTarget.OnInvalidatingCounters(TableEventArgs)
Triggered when the InvalidatingCounters event is done.
Declaration
void ITableEventsTarget.OnInvalidatingCounters(TableEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableEventArgs | e | The TableEventArgs contains the event data. |
ITableEventsTarget.OnInvalidatingSummaries(TableEventArgs)
Triggered when the InvalidatingSummaries event is done.
Declaration
void ITableEventsTarget.OnInvalidatingSummaries(TableEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableEventArgs | e | The TableEventArgs contains the event data. |
ITableEventsTarget.OnRecordCollapsed(RecordEventArgs)
Triggered when the RecordCollapsed event is done.
Declaration
void ITableEventsTarget.OnRecordCollapsed(RecordEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordEventArgs | e | The RecordEventArgs contains the event data. |
ITableEventsTarget.OnRecordCollapsing(RecordEventArgs)
Triggered when the RecordCollapsing event is done.
Declaration
void ITableEventsTarget.OnRecordCollapsing(RecordEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordEventArgs | e | The RecordEventArgs contains the event data. |
ITableEventsTarget.OnRecordDeleted(RecordEventArgs)
Triggered when the RecordDeleted event is done.
Declaration
void ITableEventsTarget.OnRecordDeleted(RecordEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordEventArgs | e | The RecordEventArgs contains the event data. |
ITableEventsTarget.OnRecordDeleting(RecordEventArgs)
Triggered when the RecordDeleting event is done.
Declaration
void ITableEventsTarget.OnRecordDeleting(RecordEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordEventArgs | e | The RecordEventArgs contains the event data. |
ITableEventsTarget.OnRecordExpanded(RecordEventArgs)
Triggered when the RecordExpanded event is done.
Declaration
void ITableEventsTarget.OnRecordExpanded(RecordEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordEventArgs | e | The RecordEventArgs contains the event data. |
ITableEventsTarget.OnRecordExpanding(RecordEventArgs)
Triggered when the RecordExpanding event is done.
Declaration
void ITableEventsTarget.OnRecordExpanding(RecordEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordEventArgs | e | The RecordEventArgs contains the event data. |
ITableEventsTarget.OnRecordValueChanged(RecordValueChangedEventArgs)
Triggered when the RecordValueChanged event is done.
Declaration
void ITableEventsTarget.OnRecordValueChanged(RecordValueChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordValueChangedEventArgs | e | The RecordValueChangedEventArgs contains the event data. |
ITableEventsTarget.OnRecordValueChanging(RecordValueChangingEventArgs)
Triggered when the RecordValueChanging event is done.
Declaration
void ITableEventsTarget.OnRecordValueChanging(RecordValueChangingEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordValueChangingEventArgs | e | The RecordValueChangingEventArgs contains the event data. |
ITableEventsTarget.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)
Triggered when the SelectedRecordsChanged event is done.
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)
Triggered when the SortingItemsInGroup event is done.
Declaration
void ITableEventsTarget.OnSortedItemsInGroup(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs event is done. |
ITableEventsTarget.OnSortingItemsInGroup(GroupEventArgs)
Triggered when the SortingItemsInGroup event is done.
Declaration
void ITableEventsTarget.OnSortingItemsInGroup(GroupEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| GroupEventArgs | e | The GroupEventArgs contains the event data. |
ITableEventsTarget.OnSourceListListChanged(TableListChangedEventArgs)
Triggered when the SourceListListChanged event is done.
Declaration
void ITableEventsTarget.OnSourceListListChanged(TableListChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableListChangedEventArgs | e | The TableListChangedEventArgs contains the event data. |
ITableEventsTarget.OnSourceListListChangedCompleted(TableListChangedEventArgs)
Triggered when the SourceListListChangedCompleted event is done.
Declaration
void ITableEventsTarget.OnSourceListListChangedCompleted(TableListChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableListChangedEventArgs | e | The TableListChangedEventArgs contains the event data. |
ITableEventsTarget.OnSourceListRecordChanged(RecordChangedEventArgs)
Triggered when the SourceListRecordChanged is done.
Declaration
void ITableEventsTarget.OnSourceListRecordChanged(RecordChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordChangedEventArgs | e | The RecordChangedEventArgs contains the event data. |
ITableEventsTarget.OnSourceListRecordChanging(RecordChangedEventArgs)
Triggered when the SourceListRecordChanging event is done.
Declaration
void ITableEventsTarget.OnSourceListRecordChanging(RecordChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordChangedEventArgs | e | The RecordChangedEventArgs contains the event data. |
ITableEventsTarget.OnTableSourceListChanged(TableEventArgs)
Triggered when the TableSourceListChanged event is done.
Declaration
void ITableEventsTarget.OnTableSourceListChanged(TableEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TableEventArgs | e | The TableEventArgs contains the event data. |