Class GridDataTable
Inheritance
System.Object
GridDataTable
Implements
System.IDisposable
System.ComponentModel.ISupportInitialize
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public class GridDataTable : Disposable, IDisposable, ISupportInitialize
Constructors
GridDataTable(GridDataTableModel)
Initializes a new instance of the class.
Declaration
public GridDataTable(GridDataTableModel parentGroup)
Parameters
Properties
GroupModel
Declaration
public GridDataTopLevelGroup GroupModel { get; }
Property Value
Gets a value indicating whether this instance has conditional formats.
Declaration
public bool HasConditionalFormats { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has conditional formats; otherwise, false .
|
HasDetailsView
Gets a value indicating whether this instance has detail view.
Declaration
public bool HasDetailsView { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has detail view; otherwise, false .
|
HasExpressionColumns
Gets a value indicating whether this instance has expression columns.
Declaration
public bool HasExpressionColumns { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has expression columns; otherwise, false .
|
HasFilters
Gets a value specifying if the Model has filters applied.
Declaration
public bool HasFilters { get; }
Property Value
HasGroups
Gets a value indicating whether this instance has groups.
Declaration
public bool HasGroups { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has groups; otherwise, false .
|
HasNestedTables
Gets a value indicating whether this instance has nested tables.
Declaration
public bool HasNestedTables { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has nested tables; otherwise, false .
|
Gets a value indicating whether this instance has stacked headers.
Declaration
public bool HasStackedHeaders { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has stacked headers; otherwise, false .
|
HasTableSummaries
Gets a value indicating whether this instance has table summaries.
Declaration
public bool HasTableSummaries { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has table summaries; otherwise, false .
|
HasUnboundColumns
Gets a value indicating whether this instance has unbound columns.
Declaration
public bool HasUnboundColumns { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance has unbound columns; otherwise, false .
|
IsDynamicBound
Gets a value indicating whether this instance is dynamic bound.
Declaration
public bool IsDynamicBound { get; }
Property Value
Type |
Description |
System.Boolean |
true if this instance is dynamic bound; otherwise, false .
|
Model
Gets or sets the parent group.
Declaration
public GridDataTableModel Model { get; }
Property Value
TotalColumnCount
Gets the total column count.
Declaration
public int TotalColumnCount { get; }
Property Value
Type |
Description |
System.Int32 |
The total column count.
|
Methods
add_ChildModelLoaded(ChildModelLoadedEventHandler)
Declaration
public void add_ChildModelLoaded(ChildModelLoadedEventHandler value)
Parameters
add_CurrentCellChanged(GridDataCurentCellChangedEventHandler)
Declaration
public void add_CurrentCellChanged(GridDataCurentCellChangedEventHandler value)
Parameters
add_CurrentCellValidating(GridDataCurrentCellValidatingEventHandler)
Declaration
public void add_CurrentCellValidating(GridDataCurrentCellValidatingEventHandler value)
Parameters
add_DetailsViewExpanded(GridDataDetailsViewExpandedEventHandler)
Declaration
public void add_DetailsViewExpanded(GridDataDetailsViewExpandedEventHandler value)
Parameters
add_DetailsViewExpanding(GridDataDetailsViewExpandingEventHandler)
Declaration
public void add_DetailsViewExpanding(GridDataDetailsViewExpandingEventHandler value)
Parameters
add_GroupCollapsed(GroupCollapsedEventHandler)
Declaration
public void add_GroupCollapsed(GroupCollapsedEventHandler value)
Parameters
add_GroupCollapsing(GroupCollapsingEventHandler)
Declaration
public void add_GroupCollapsing(GroupCollapsingEventHandler value)
Parameters
add_GroupedColumnsChanged(GridDataGroupedColumnsChangedEventHandler)
Declaration
public void add_GroupedColumnsChanged(GridDataGroupedColumnsChangedEventHandler value)
Parameters
add_GroupExpanded(GroupExpandedEventHandler)
Declaration
public void add_GroupExpanded(GroupExpandedEventHandler value)
Parameters
add_GroupExpanding(GroupExpandingEventHandler)
Declaration
public void add_GroupExpanding(GroupExpandingEventHandler value)
Parameters
add_InitializingNewItem(GridDataInitializingNewItemEventHandler)
Declaration
public void add_InitializingNewItem(GridDataInitializingNewItemEventHandler value)
Parameters
add_RecordAdded(GridDataNewRecordAddedEventHandler)
Declaration
public void add_RecordAdded(GridDataNewRecordAddedEventHandler value)
Parameters
add_RecordAdding(GridDataNewRecordAddingEventHandler)
Declaration
public void add_RecordAdding(GridDataNewRecordAddingEventHandler value)
Parameters
add_RecordDeleted(GridDataRecordDeletedEventHandler)
Declaration
public void add_RecordDeleted(GridDataRecordDeletedEventHandler value)
Parameters
add_RecordDeleting(GridDataRecordDeletingEventHandler)
Declaration
public void add_RecordDeleting(GridDataRecordDeletingEventHandler value)
Parameters
add_RecordExpanding(GridDataRecordExpandingEventHandler)
Declaration
public void add_RecordExpanding(GridDataRecordExpandingEventHandler value)
Parameters
add_RecordSelectionChanging(GridDataRecordSelectionChangingEventHandler)
Declaration
public void add_RecordSelectionChanging(GridDataRecordSelectionChangingEventHandler value)
Parameters
add_RecordsSelectionChanged(GridDataRecordsSelectionChangedEventHandler)
Declaration
public void add_RecordsSelectionChanged(GridDataRecordsSelectionChangedEventHandler value)
Parameters
add_SortColumnsChanged(GridDataSortColumnsChangedEventHandler)
Declaration
public void add_SortColumnsChanged(GridDataSortColumnsChangedEventHandler value)
Parameters
add_SortColumnsChanging(GridDataSortColumnsChangingEventHandler)
Declaration
public void add_SortColumnsChanging(GridDataSortColumnsChangingEventHandler value)
Parameters
BeginInit()
Signals the object that initialization is starting.
Declaration
CollapseAll()
Collapses all the nested tables for all the records.
Declaration
public void CollapseAll()
CollapseAllDetailsViews()
Collapses all the nested tables for all the records.
Declaration
public void CollapseAllDetailsViews()
CollapseAllGroups()
Declaration
public void CollapseAllGroups()
CollapseAllGroupsAtLevel(Int32)
Collapses all groups at level.
Declaration
public void CollapseAllGroupsAtLevel(int level)
Parameters
Type |
Name |
Description |
System.Int32 |
level |
The level.
|
CollapseAt(Int32)
Collapses the nested table at specified record index.
Declaration
public void CollapseAt(int recordIndex)
Parameters
Type |
Name |
Description |
System.Int32 |
recordIndex |
|
CollapseDetailsViewAt(Int32)
Collapses the nested table at specified record index.
Declaration
public void CollapseDetailsViewAt(int recordIndex)
Parameters
Type |
Name |
Description |
System.Int32 |
recordIndex |
|
CollapseGroup(Group)
Declaration
public void CollapseGroup(Group group)
Parameters
Type |
Name |
Description |
Syncfusion.Windows.Data.Group |
group |
The group.
|
Dispose(Boolean)
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type |
Name |
Description |
System.Boolean |
disposing |
|
Overrides
EndInit()
Signals the object that initialization is complete.
Declaration
ExpandAll()
Expands all the records with nested tables.
Declaration
ExpandAllDetailsViews()
Expands all the records with nested tables.
Declaration
public void ExpandAllDetailsViews()
ExpandAllGroups()
Declaration
public void ExpandAllGroups()
ExpandAllGroupsAtLevel(Int32)
Expands all groups at level.
Declaration
public void ExpandAllGroupsAtLevel(int level)
Parameters
Type |
Name |
Description |
System.Int32 |
level |
The level.
|
ExpandDetailsViewAt(Int32)
Expands the record at specified record index.
Declaration
public void ExpandDetailsViewAt(int recordIndex)
Parameters
Type |
Name |
Description |
System.Int32 |
recordIndex |
Index of the record.
|
ExpandGroup(Group)
Declaration
public void ExpandGroup(Group group)
Parameters
Type |
Name |
Description |
Syncfusion.Windows.Data.Group |
group |
The group.
|
ExpandRecordAt(Int32)
Expands the record at specified record index.
Declaration
public void ExpandRecordAt(int recordIndex)
Parameters
Type |
Name |
Description |
System.Int32 |
recordIndex |
Index of the record.
|
GetRecordFromRow(Int32)
Gets the record from the actual row index present in the Grid. You could use this in MouseDown events.
Declaration
public object GetRecordFromRow(int rowIndex)
Parameters
Type |
Name |
Description |
System.Int32 |
rowIndex |
Index of the row.
|
Returns
GetUnboundValue(Int32, GridDataUnboundVisibleColumn)
Declaration
public object GetUnboundValue(int recordIndex, GridDataUnboundVisibleColumn column)
Parameters
Returns
GetUnboundValue(Int32, Int32)
Declaration
public object GetUnboundValue(int rowIdx, int colIdx)
Parameters
Type |
Name |
Description |
System.Int32 |
rowIdx |
The row idx.
|
System.Int32 |
colIdx |
The col idx.
|
Returns
GetUnboundValue(Object, GridDataUnboundVisibleColumn)
Declaration
public object GetUnboundValue(object record, GridDataUnboundVisibleColumn column)
Parameters
Returns
GetUnboundValue(Object, String)
Declaration
public object GetUnboundValue(object record, string columnName)
Parameters
Type |
Name |
Description |
System.Object |
record |
The record.
|
System.String |
columnName |
Name of the column.
|
Returns
GetValue(Int32, String)
Gets the value of the column from the record. This method returns proper results for data when it is grouped / cached in edit mode.
Declaration
public object GetValue(int recordIndex, string columnName)
Parameters
Type |
Name |
Description |
System.Int32 |
recordIndex |
Index of the record.
|
System.String |
columnName |
Name of the column.
|
Returns
GetValue(Object, String)
Gets the value of the underlying record object.
Declaration
public object GetValue(object record, string columnName)
Parameters
Type |
Name |
Description |
System.Object |
record |
The record.
|
System.String |
columnName |
Name of the column.
|
Returns
OnRaiseInitializingNewItem(GridDataInitializingNewItemEventArgs)
Declaration
protected virtual void OnRaiseInitializingNewItem(GridDataInitializingNewItemEventArgs args)
Parameters
OnRecordAdded(GridDataNewRecordAddedEventArgs)
Declaration
protected virtual void OnRecordAdded(GridDataNewRecordAddedEventArgs args)
Parameters
OnRecordAdding(GridDataNewRecordAddingEventArgs)
Declaration
protected virtual void OnRecordAdding(GridDataNewRecordAddingEventArgs args)
Parameters
OnRecordsSelectionChanged(GridDataRecordsSelectionChangedEventArgs)
Declaration
protected virtual void OnRecordsSelectionChanged(GridDataRecordsSelectionChangedEventArgs e)
Parameters
OnRecordsSelectionChanging(GridDataRecordSelectionChangingEventArgs)
Declaration
protected virtual void OnRecordsSelectionChanging(GridDataRecordSelectionChangingEventArgs e)
Parameters
remove_ChildModelLoaded(ChildModelLoadedEventHandler)
Declaration
public void remove_ChildModelLoaded(ChildModelLoadedEventHandler value)
Parameters
remove_CurrentCellChanged(GridDataCurentCellChangedEventHandler)
Declaration
public void remove_CurrentCellChanged(GridDataCurentCellChangedEventHandler value)
Parameters
remove_CurrentCellValidating(GridDataCurrentCellValidatingEventHandler)
Declaration
public void remove_CurrentCellValidating(GridDataCurrentCellValidatingEventHandler value)
Parameters
remove_DetailsViewExpanded(GridDataDetailsViewExpandedEventHandler)
Declaration
public void remove_DetailsViewExpanded(GridDataDetailsViewExpandedEventHandler value)
Parameters
remove_DetailsViewExpanding(GridDataDetailsViewExpandingEventHandler)
Declaration
public void remove_DetailsViewExpanding(GridDataDetailsViewExpandingEventHandler value)
Parameters
remove_GroupCollapsed(GroupCollapsedEventHandler)
Declaration
public void remove_GroupCollapsed(GroupCollapsedEventHandler value)
Parameters
remove_GroupCollapsing(GroupCollapsingEventHandler)
Declaration
public void remove_GroupCollapsing(GroupCollapsingEventHandler value)
Parameters
remove_GroupedColumnsChanged(GridDataGroupedColumnsChangedEventHandler)
Declaration
public void remove_GroupedColumnsChanged(GridDataGroupedColumnsChangedEventHandler value)
Parameters
remove_GroupExpanded(GroupExpandedEventHandler)
Declaration
public void remove_GroupExpanded(GroupExpandedEventHandler value)
Parameters
remove_GroupExpanding(GroupExpandingEventHandler)
Declaration
public void remove_GroupExpanding(GroupExpandingEventHandler value)
Parameters
remove_InitializingNewItem(GridDataInitializingNewItemEventHandler)
Declaration
public void remove_InitializingNewItem(GridDataInitializingNewItemEventHandler value)
Parameters
remove_RecordAdded(GridDataNewRecordAddedEventHandler)
Declaration
public void remove_RecordAdded(GridDataNewRecordAddedEventHandler value)
Parameters
remove_RecordAdding(GridDataNewRecordAddingEventHandler)
Declaration
public void remove_RecordAdding(GridDataNewRecordAddingEventHandler value)
Parameters
remove_RecordDeleted(GridDataRecordDeletedEventHandler)
Declaration
public void remove_RecordDeleted(GridDataRecordDeletedEventHandler value)
Parameters
remove_RecordDeleting(GridDataRecordDeletingEventHandler)
Declaration
public void remove_RecordDeleting(GridDataRecordDeletingEventHandler value)
Parameters
remove_RecordExpanding(GridDataRecordExpandingEventHandler)
Declaration
public void remove_RecordExpanding(GridDataRecordExpandingEventHandler value)
Parameters
remove_RecordSelectionChanging(GridDataRecordSelectionChangingEventHandler)
Declaration
public void remove_RecordSelectionChanging(GridDataRecordSelectionChangingEventHandler value)
Parameters
remove_RecordsSelectionChanged(GridDataRecordsSelectionChangedEventHandler)
Declaration
public void remove_RecordsSelectionChanged(GridDataRecordsSelectionChangedEventHandler value)
Parameters
remove_SortColumnsChanged(GridDataSortColumnsChangedEventHandler)
Declaration
public void remove_SortColumnsChanged(GridDataSortColumnsChangedEventHandler value)
Parameters
remove_SortColumnsChanging(GridDataSortColumnsChangingEventHandler)
Declaration
public void remove_SortColumnsChanging(GridDataSortColumnsChangingEventHandler value)
Parameters
Events
ChildModelLoaded
Declaration
public event ChildModelLoadedEventHandler ChildModelLoaded
Event Type
CurrentCellChanged
Occurs when the current cell is changed.
Declaration
public event GridDataCurentCellChangedEventHandler CurrentCellChanged
Event Type
CurrentCellValidating
Occurs when the current cell value is validating.
Declaration
public event GridDataCurrentCellValidatingEventHandler CurrentCellValidating
Event Type
DetailsViewCollapsed
Occurs when [details view collapsed].
Declaration
public event EventHandler<GridDataValueEventArgs<GridDataRecord>> DetailsViewCollapsed
Event Type
DetailsViewCollapsing
Occurs when [details view collapsing].
Declaration
public event EventHandler<GridDataValueCancelEventArgs<GridDataRecord>> DetailsViewCollapsing
Event Type
DetailsViewExpanded
Occurs when [details view expanded].
Declaration
public event GridDataDetailsViewExpandedEventHandler DetailsViewExpanded
Event Type
DetailsViewExpanding
Occurs when [details view expanding].
Declaration
public event GridDataDetailsViewExpandingEventHandler DetailsViewExpanding
Event Type
GroupCollapsed
Occurs when the group is collapsed.
Declaration
public event GroupCollapsedEventHandler GroupCollapsed
Event Type
GroupCollapsing
Occurs when the group is collapsing.
Declaration
public event GroupCollapsingEventHandler GroupCollapsing
Event Type
GroupedColumnsChanged
Occurs when the grouped columns are changed.
Declaration
public event GridDataGroupedColumnsChangedEventHandler GroupedColumnsChanged
Event Type
GroupExpanded
Occurs when the group is expanded.
Declaration
public event GroupExpandedEventHandler GroupExpanded
Event Type
GroupExpanding
Occurs when the group is expanding.
Declaration
public event GroupExpandingEventHandler GroupExpanding
Event Type
InitializingNewItem
Declaration
public event GridDataInitializingNewItemEventHandler InitializingNewItem
Event Type
RecordAdded
Occurs when a new record is added from insert new record row
Declaration
public event GridDataNewRecordAddedEventHandler RecordAdded
Event Type
RecordAdding
Occurs when a new record is adding from insert new record row
Declaration
public event GridDataNewRecordAddingEventHandler RecordAdding
Event Type
RecordAfterBeginEdit
Occurs when the record completes the begin edit state.
Declaration
public event EventHandler<GridDataValueEventArgs<int>> RecordAfterBeginEdit
Event Type
RecordBeforeBeginEdit
Occurs when the record goes into begin edit state.
Declaration
public event EventHandler<GridDataValueCancelEventArgs<int>> RecordBeforeBeginEdit
Event Type
RecordCollapsed
Occurs when the record is collapsed.
Declaration
public event EventHandler<GridDataValueEventArgs<GridDataRecord>> RecordCollapsed
Event Type
RecordCollapsing
Occurs when the record is collapsing.
Declaration
public event EventHandler<GridDataValueCancelEventArgs<GridDataRecord>> RecordCollapsing
Event Type
RecordDeleted
Occurs when the record is deleted.
Declaration
public event GridDataRecordDeletedEventHandler RecordDeleted
Event Type
RecordDeleting
Occurs when the record is deleting.
Declaration
public event GridDataRecordDeletingEventHandler RecordDeleting
Event Type
RecordEndEdit
Occurs when the record completes the end edit.
Declaration
public event EventHandler<GridDataValueEventArgs<int>> RecordEndEdit
Event Type
RecordExpanded
Occurs when the record is expanded.
Declaration
public event EventHandler<GridDataValueEventArgs<GridDataRecord>> RecordExpanded
Event Type
RecordExpanding
Occurs when the record is expanding.
Declaration
public event GridDataRecordExpandingEventHandler RecordExpanding
Event Type
RecordSelectionChanging
Declaration
public event GridDataRecordSelectionChangingEventHandler RecordSelectionChanging
Event Type
RecordsSelectionChanged
Declaration
public event GridDataRecordsSelectionChangedEventHandler RecordsSelectionChanged
Event Type
SortColumnsChanged
Occurs when the sort columns are changed.
Declaration
public event GridDataSortColumnsChangedEventHandler SortColumnsChanged
Event Type
SortColumnsChanging
Occurs when the sort columns are changing.
Declaration
public event GridDataSortColumnsChangingEventHandler SortColumnsChanging
Event Type
Implements
System.IDisposable
System.ComponentModel.ISupportInitialize