Class GridDataTableModel

Represents the child tables in groups of PrimaryKey columns.

Inheritance
System.Object
GridModel
GridDataTableModel
GridDataChildTableModel
Implements
System.IDisposable
System.ComponentModel.ISupportInitialize
Inherited Members
System.Object.ToString()
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.Windows.Controls.Grid
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public class GridDataTableModel : GridModel, IGridVolatileCellStylesHost, IOperationFeedbackProvider, IDisposable, ISupportInitialize

Constructors

GridDataTableModel()

Declaration
public GridDataTableModel()

GridDataTableModel(GridControlBase)

Initializes a new instance of the class.

Declaration
public GridDataTableModel(GridControlBase grid)
Parameters
Type Name Description
GridControlBase grid

The GridControlBase which is binded with the TableModel

Fields

DefaultRowHeight

Declaration
public const double DefaultRowHeight = 24
Field Value
Type Description
System.Double

ExpandCollapseCellWidth

Declaration
public const double ExpandCollapseCellWidth = 24
Field Value
Type Description
System.Double

gridDataTable

private accessor for GridTable.

Declaration
protected GridDataTable gridDataTable
Field Value
Type Description
GridDataTable

HeaderRowHeight

Declaration
public const double HeaderRowHeight = 28
Field Value
Type Description
System.Double

inSerialization

Declaration
public bool inSerialization
Field Value
Type Description
System.Boolean

Properties

ColumnAutoSizer

Declaration
public GridDataControlColumnSizer ColumnAutoSizer { get; }
Property Value
Type Description
GridDataControlColumnSizer

CurrencyManager

Gets or sets the currency manager.

Declaration
public GridDataCurrentRecordManager CurrencyManager { get; }
Property Value
Type Description
GridDataCurrentRecordManager

The currency manager.

Grid

Gets or sets the grid.

Declaration
public GridControlBase Grid { get; set; }
Property Value
Type Description
GridControlBase

The grid.

GridVisualStyle

Gets or sets the grid visual style.

Declaration
public IGridDataVisualStyle GridVisualStyle { get; set; }
Property Value
Type Description
IGridDataVisualStyle

The grid visual style.

InCollectionViewCurrency

Declaration
protected bool InCollectionViewCurrency { get; set; }
Property Value
Type Description
System.Boolean

InCurrencyManager

Declaration
protected bool InCurrencyManager { get; set; }
Property Value
Type Description
System.Boolean

IndentColumnStyle

Declaration
public GridStyleInfo IndentColumnStyle { get; }
Property Value
Type Description
GridStyleInfo

IsEditing

Gets a value indicating whether this instance is editing.

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

true if this instance is editing; otherwise, false.

IsInColumnRefresh

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

IsInFilter

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

IsInFilterOverride

Declaration
protected bool IsInFilterOverride { get; set; }
Property Value
Type Description
System.Boolean

IsInGroup

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

IsInitialized

Gets or sets a value indicating whether IsInitialized property. Specifies if the object needs to be re-initialized.

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

true if this instance is initialized; otherwise, false.

IsInSort

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

IsInSourceListChanged

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

IsInSuspend

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

IsLoaded

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

IsSourceListReset

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

RefreshWholeRow

Gets or sets the grid should refresh the whole row even if a single cell in the row changes.

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

if you want the grid to change the backcolor of a whole row when a single value changes, then the grid needs to redraw the whole row when the value changes.

SourceList

Gets the source list.

Declaration
public IEnumerable SourceList { get; }
Property Value
Type Description
System.Collections.IEnumerable

Specifies the SourceList.

SourceListCount

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

Table

Gets the child table.

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

The child table.

TableProperties

Gets or sets the table descriptor.

Declaration
public GridDataTableProperties TableProperties { get; set; }
Property Value
Type Description
GridDataTableProperties

The table descriptor.

UnboundRowsCount

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

View

Gets or sets the ICollectionViewAdv which interacts with the Model.

Declaration
public ICollectionViewAdv View { get; }
Property Value
Type Description
ICollectionViewAdv

Methods

ApplyFont()

Declaration
public void ApplyFont()

BeginInit()

Declaration
public void BeginInit()

CreateAutoSizer()

Declaration
protected override GridColumnAutoSizer CreateAutoSizer()
Returns
Type Description
GridColumnAutoSizer
Overrides

CreateCollectionViewAdv(IEnumerable)

Declaration
public virtual ICollectionViewAdv CreateCollectionViewAdv(IEnumerable source)
Parameters
Type Name Description
System.Collections.IEnumerable source
Returns
Type Description
ICollectionViewAdv

CreateGridMoveCellsState(IEditableLineSizeHost)

Declaration
protected override GridMoveCellsState CreateGridMoveCellsState(IEditableLineSizeHost lineSizes)
Parameters
Type Name Description
IEditableLineSizeHost lineSizes
Returns
Type Description
GridMoveCellsState
Overrides

CreateVolatileCellStyles()

Creates the volatile cell styles.

Declaration
protected override GridVolatileCellStyles CreateVolatileCellStyles()
Returns
Type Description
GridVolatileCellStyles
Overrides

Deserialize(String)

Deserializes the specified GridDataTableModel.

Declaration
public override void Deserialize(string fileName)
Parameters
Type Name Description
System.String fileName
Overrides

DeserializeFromStream(TextReader)

Deserializes from stream.

Declaration
public override void DeserializeFromStream(TextReader textReader)
Parameters
Type Name Description
System.IO.TextReader textReader

The text reader.
Overrides

DeserializeFromString(String)

Deserializes GridDataTableModel properties from string.

Declaration
public override void DeserializeFromString(string content)
Parameters
Type Name Description
System.String content

The content.
Overrides

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources

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

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

EndInit()

Declaration
public void EndInit()

EnsureInitialized()

Ensures the object are initialized.

Declaration
protected virtual void EnsureInitialized()

FilterColumn(GridDataVisibleColumn, List<FilterPredicate>, Boolean, Boolean)

Declaration
protected virtual void FilterColumn(GridDataVisibleColumn column, List<FilterPredicate> filterPredicates, bool canApplyFilter, bool isDomaingrid)
Parameters
Type Name Description
GridDataVisibleColumn column
System.Collections.Generic.List<FilterPredicate> filterPredicates
System.Boolean canApplyFilter
System.Boolean isDomaingrid

FilterColumnMethod(GridDataVisibleColumn, Object, FilterType, PredicateType, Boolean, Boolean)

Declaration
protected virtual void FilterColumnMethod(GridDataVisibleColumn column, object filterValue, FilterType filterType, PredicateType predicateType, bool isCaseSensitive, bool canApplyFilter)
Parameters
Type Name Description
GridDataVisibleColumn column
System.Object filterValue
FilterType filterType
PredicateType predicateType
System.Boolean isCaseSensitive
System.Boolean canApplyFilter

GetboundExpressionFuncMethod(String)

Declaration
protected virtual Expression<Func<string, object, object>> GetboundExpressionFuncMethod(string propertyName)
Parameters
Type Name Description
System.String propertyName
Returns
Type Description
System.Linq.Expressions.Expression<System.Func<System.String, System.Object, System.Object>>

GetDefaultView(IEnumerable)

Declaration
public static ICollectionViewAdv GetDefaultView(IEnumerable source)
Parameters
Type Name Description
System.Collections.IEnumerable source
Returns
Type Description
ICollectionViewAdv

GetDynamicVisibleColumns()

Declaration
public GridDataVisibleColumns GetDynamicVisibleColumns()
Returns
Type Description
GridDataVisibleColumns

GetFilters()

Declaration
protected ObservableCollection<IFilterDefinition> GetFilters()
Returns
Type Description
System.Collections.ObjectModel.ObservableCollection<IFilterDefinition>

GetGroupCaptionSummary(Group, ISummaryColumn)

Declaration
public Dictionary<string, object> GetGroupCaptionSummary(Group group, ISummaryColumn summaryColumn)
Parameters
Type Name Description
Group group
ISummaryColumn summaryColumn
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

GetGroupSummary(Group, ISummaryRow, ISummaryColumn)

Declaration
public Dictionary<string, object> GetGroupSummary(Group group, ISummaryRow summaryRow, ISummaryColumn summaryColumn)
Parameters
Type Name Description
Group group
ISummaryRow summaryRow
ISummaryColumn summaryColumn
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

GetResolveStartIndexBasedOnPosition()

Declaration
protected int GetResolveStartIndexBasedOnPosition()
Returns
Type Description
System.Int32

GetSourceList(Object)

Declaration
public virtual IEnumerable GetSourceList(object source)
Parameters
Type Name Description
System.Object source
Returns
Type Description
System.Collections.IEnumerable

GetTableSummary(ISummaryRow, ISummaryColumn)

Declaration
public Dictionary<string, object> GetTableSummary(ISummaryRow summaryRow, ISummaryColumn summaryColumn)
Parameters
Type Name Description
ISummaryRow summaryRow
ISummaryColumn summaryColumn
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

GetUnboundExpressionFuncMethod(String)

Declaration
protected virtual Expression<Func<string, object, object>> GetUnboundExpressionFuncMethod(string propertyName)
Parameters
Type Name Description
System.String propertyName
Returns
Type Description
System.Linq.Expressions.Expression<System.Func<System.String, System.Object, System.Object>>

GetVisibleColumns()

Declaration
public GridDataVisibleColumns GetVisibleColumns()
Returns
Type Description
GridDataVisibleColumns

GetVisualStyleDictionary(FrameworkElement)

Returns the VisualStyle ResourceDictionary.

Declaration
public ResourceDictionary GetVisualStyleDictionary(FrameworkElement element)
Parameters
Type Name Description
System.Windows.FrameworkElement element
Returns
Type Description
System.Windows.ResourceDictionary

InsertColumnsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected override void InsertColumnsCore(int insertAtColumnIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 insertAtColumnIndex
System.Int32 count
GridMoveCellsState moveCellsState
Overrides

InsertRowsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected override void InsertRowsCore(int insertAtRowIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 insertAtRowIndex
System.Int32 count
GridMoveCellsState moveCellsState
Overrides

OnClipboardCanPaste(GridCutPasteEventArgs)

Declaration
protected override void OnClipboardCanPaste(GridCutPasteEventArgs e)
Parameters
Type Name Description
GridCutPasteEventArgs e
Overrides

OnContextMenuCreating()

Declaration
protected override ContextMenu OnContextMenuCreating()
Returns
Type Description
System.Windows.Controls.ContextMenu
Overrides

OnFilterChanged(GridFilterEventArgs)

Declaration
protected void OnFilterChanged(GridFilterEventArgs e)
Parameters
Type Name Description
GridFilterEventArgs e

OnFilterChanging(GridFilterEventArgs)

Declaration
protected void OnFilterChanging(GridFilterEventArgs e)
Parameters
Type Name Description
GridFilterEventArgs e

OnQueryBaseStyles(GridQueryBaseStylesEventArgs)

Declaration
protected override void OnQueryBaseStyles(GridQueryBaseStylesEventArgs e)
Parameters
Type Name Description
GridQueryBaseStylesEventArgs e
Overrides

OnQueryCellInfo(GridQueryCellInfoEventArgs)

Declaration
protected override void OnQueryCellInfo(GridQueryCellInfoEventArgs e)
Parameters
Type Name Description
GridQueryCellInfoEventArgs e
Overrides

OnQueryContextMenuInfo(GridQueryContextMenuInfoEventArgs)

Declaration
protected override void OnQueryContextMenuInfo(GridQueryContextMenuInfoEventArgs e)
Parameters
Type Name Description
GridQueryContextMenuInfoEventArgs e
Overrides

OnQueryCoveredRange(GridQueryCoveredRangeEventArgs)

Declaration
protected override void OnQueryCoveredRange(GridQueryCoveredRangeEventArgs e)
Parameters
Type Name Description
GridQueryCoveredRangeEventArgs e
Overrides

OnQueryVisibleColumnInfo(QueryVisibleColumnInfoArgs)

Declaration
protected virtual void OnQueryVisibleColumnInfo(QueryVisibleColumnInfoArgs args)
Parameters
Type Name Description
QueryVisibleColumnInfoArgs args

OnRowsInserted(GridRangeInsertedEventArgs)

Declaration
protected override void OnRowsInserted(GridRangeInsertedEventArgs e)
Parameters
Type Name Description
GridRangeInsertedEventArgs e
Overrides

OnRowsRemoved(GridRangeRemovedEventArgs)

Declaration
protected override void OnRowsRemoved(GridRangeRemovedEventArgs e)
Parameters
Type Name Description
GridRangeRemovedEventArgs e
Overrides

OnUpdateAutoSizer(Boolean, Boolean)

Declaration
protected override void OnUpdateAutoSizer(bool applySizes, bool columnSizerChanged)
Parameters
Type Name Description
System.Boolean applySizes
System.Boolean columnSizerChanged
Overrides

RaiseQueryVisibleColumnInfo(QueryVisibleColumnInfoArgs)

Declaration
public void RaiseQueryVisibleColumnInfo(QueryVisibleColumnInfoArgs e)
Parameters
Type Name Description
QueryVisibleColumnInfoArgs e

RefreshChildRecord()

Declaration
public void RefreshChildRecord()

RefreshDisplayMethod(Boolean)

Declaration
protected void RefreshDisplayMethod(bool needsRefreshTable)
Parameters
Type Name Description
System.Boolean needsRefreshTable

RefreshSourceListCountMethod()

Declaration
protected void RefreshSourceListCountMethod()

RemoveColumnsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected override void RemoveColumnsCore(int removeAtColumnIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 removeAtColumnIndex
System.Int32 count
GridMoveCellsState moveCellsState
Overrides

RemoveRowsCore(Int32, Int32, GridMoveCellsState)

Declaration
protected override void RemoveRowsCore(int removeAtRowIndex, int count, GridMoveCellsState moveCellsState)
Parameters
Type Name Description
System.Int32 removeAtRowIndex
System.Int32 count
GridMoveCellsState moveCellsState
Overrides

ResizeDataColumnsToFit(GridRangeInfo, GridResizeToFitOptions)

Resizes a range of columns to optimally fit contents of the specified range of cells and given options.

Declaration
public bool ResizeDataColumnsToFit(GridRangeInfo range, GridResizeToFitOptions options)
Parameters
Type Name Description
GridRangeInfo range

The range of cells to be analyzed.
GridResizeToFitOptions options

Specifies whether row or column headers should be included; if size can be reduced and if covered cells should be considered.
Returns
Type Description
System.Boolean

True if any changes were made; False if all sizes were already optimal.

ResumeEvents()

Declaration
public void ResumeEvents()

Serialize(String)

Serializes the specified properties in the GridDataTableModel.

Declaration
public override void Serialize(string fileName)
Parameters
Type Name Description
System.String fileName
Overrides

SerializeAsString()

Serializes the GridDataTableModel properties as string.

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

SerializeToStream(TextWriter)

Serializes to stream.

Declaration
public override void SerializeToStream(TextWriter textWriter)
Parameters
Type Name Description
System.IO.TextWriter textWriter

The text writer.
Overrides

SetTableDirty()

Declaration
public void SetTableDirty()

ShouldHideRow(Int32, Boolean)

Declaration
protected override bool ShouldHideRow(int rowIndex, bool hide)
Parameters
Type Name Description
System.Int32 rowIndex
System.Boolean hide
Returns
Type Description
System.Boolean
Overrides

SortColumnMethod(GridDataVisibleColumn)

Declaration
protected virtual void SortColumnMethod(GridDataVisibleColumn column)
Parameters
Type Name Description
GridDataVisibleColumn column

SuspendEvents()

Declaration
public void SuspendEvents()

UpdateSelectedRanges()

Declaration
public virtual void UpdateSelectedRanges()

WireSourceList(Boolean)

Wires the source list. This also will only refresh the internal collections without refreshing the whole grid itself.

Declaration
public void WireSourceList(bool needsWholeGridRefresh)
Parameters
Type Name Description
System.Boolean needsWholeGridRefresh

if set to true [needs whole grid refresh].

Events

ColumnsReset

Raised whenever the columns is reset. This occurs when data is grouped / ungrouped.

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

FilterChanged

Declaration
public event GridFilterEventHandler FilterChanged
Event Type
Type Description
GridFilterEventHandler

FilterChanging

Declaration
public event GridFilterEventHandler FilterChanging
Event Type
Type Description
GridFilterEventHandler

Initialized

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

QueryUnboundCellInfo

Declaration
public event GridDataQueryUnboundCellInfoEventHandler QueryUnboundCellInfo
Event Type
Type Description
GridDataQueryUnboundCellInfoEventHandler

QueryUnboundColumnValue

Declaration
public event GridDataQueryUnboundColumnCellEventHandler QueryUnboundColumnValue
Event Type
Type Description
GridDataQueryUnboundColumnCellEventHandler

QueryVisibleColumnInfo

Declaration
public event QueryVisibleColumnInfoEventHandler QueryVisibleColumnInfo
Event Type
Type Description
QueryVisibleColumnInfoEventHandler

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize

Extension Methods