Class DataGrid

Data Grid UI control for displaying data in table

Inheritance
System.Object
DependencyObject
UIElement
Control
ItemsControl
Selector
DataGrid
Inherited Members
Namespace: EmptyKeys.UserInterface.Controls
Assembly: EmptyKeys.UserInterface.dll
Syntax
public class DataGrid : Selector

Constructors

DataGrid()

Initializes a new instance of the DataGrid class.

Declaration
public DataGrid()

Fields

AutoGenerateColumnsProperty

The automatic generate columns property

Declaration
public static readonly DependencyProperty AutoGenerateColumnsProperty
Field Value
Type Description
DependencyProperty

EnableRowVirtualizationProperty

The enable row virtualization property

Declaration
public static readonly DependencyProperty EnableRowVirtualizationProperty
Field Value
Type Description
DependencyProperty

SelectionModeProperty

The selection mode property

Declaration
public static readonly DependencyProperty SelectionModeProperty
Field Value
Type Description
DependencyProperty

SortingCommandProperty

The sorting command property

Declaration
public static readonly DependencyProperty SortingCommandProperty
Field Value
Type Description
DependencyProperty

VirtualizedCacheMaxRowsProperty

The virtualized cache maximum rows property

Declaration
public static readonly DependencyProperty VirtualizedCacheMaxRowsProperty
Field Value
Type Description
DependencyProperty

Properties

AutoGenerateColumns

Gets or sets a value indicating whether [automatic generate columns].

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

true if [automatic generate columns]; otherwise, false.

Columns

Gets the columns.

Declaration
public ObservableCollection<DataGridColumn> Columns { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<DataGridColumn>

The columns.

EnableRowVirtualization

Gets or sets a value indicating whether [enable row virtualization].

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

true if [enable row virtualization]; otherwise, false.

HorizontalScrollBarVisibility

Gets or sets the horizontal scroll bar visibility.

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
Type Description
ScrollBarVisibility

The horizontal scroll bar visibility.

SelectionMode

Gets or sets the selection mode.

Declaration
public DataGridSelectionMode SelectionMode { get; set; }
Property Value
Type Description
DataGridSelectionMode

The selection mode.

VerticalScrollBarVisibility

Gets or sets the vertical scroll bar visibility.

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
Type Description
ScrollBarVisibility

The vertical scroll bar visibility.

Methods

ArrangeOverride(Size)

Arrange layout pass - overrider method for children

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
Type Name Description
EmptyKeys.UserInterface.Size finalSize

The final size.
Returns
Type Description
EmptyKeys.UserInterface.Size
Overrides

GetContainerForItemOverride(Object)

Gets the container for item override.

Declaration
protected override UIElement GetContainerForItemOverride(object item)
Parameters
Type Name Description
System.Object item

The item.
Returns
Type Description
UIElement
Overrides

GetSortingCommand(DependencyObject)

Gets the sorting command.

Declaration
public static ICommand GetSortingCommand(DependencyObject obj)
Parameters
Type Name Description
DependencyObject obj

The object.
Returns
Type Description
ICommand

GetVirtualizedCacheMaxRows(DependencyObject)

Gets the virtualized cache maximum rows.

Declaration
public static int GetVirtualizedCacheMaxRows(DependencyObject obj)
Parameters
Type Name Description
DependencyObject obj

The object.
Returns
Type Description
System.Int32

IsItemItsOwnContainerOverride(Object)

Determines whether if [is item its own container override].

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
Type Name Description
System.Object item

The item.
Returns
Type Description
System.Boolean
Overrides

OnApplyTemplate()

Called when [apply template].

Declaration
public override void OnApplyTemplate()
Overrides

OnItemInserted(Int32)

Called when [item inserted].

Declaration
protected override void OnItemInserted(int index)
Parameters
Type Name Description
System.Int32 index

The index.
Overrides

OnItemRemoved()

Called when [item removed].

Declaration
protected override void OnItemRemoved()
Overrides

OnItemsCleared()

Called when [items cleared].

Declaration
protected override void OnItemsCleared()
Overrides

OnKeyDown(KeyEventArgs)

Raises the KeyDown event.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
KeyEventArgs e

The KeyEventArgs instance containing the event data.
Overrides

OnPreviewGamepadMove(Object, GamepadMoveEventArgs)

Called when [preview game pad move].

Declaration
protected override void OnPreviewGamepadMove(object sender, GamepadMoveEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.
GamepadMoveEventArgs e

The GamepadMoveEventArgs instance containing the event data.
Overrides

OnPreviewMouseWheel(Object, MouseWheelEventArgs)

Called when [preview mouse wheel].

Declaration
protected override void OnPreviewMouseWheel(object sender, MouseWheelEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.
MouseWheelEventArgs e

The MouseWheelEventArgs instance containing the event data.
Overrides

OnSelectedItemChanged(DependencyPropertyChangedEventArgs)

Raises the SelectedItemChanged event.

Declaration
protected override void OnSelectedItemChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
DependencyPropertyChangedEventArgs e

The DependencyPropertyChangedEventArgs instance containing the event data.
Overrides

RaiseSortingEvent(DataGridSortingEventArgs)

Raises the sorting event.

Declaration
protected virtual void RaiseSortingEvent(DataGridSortingEventArgs args)
Parameters
Type Name Description
DataGridSortingEventArgs args

The DataGridSortingEventArgs instance containing the event data.

ScrollIntoView(Object)

Scrolls the into view.

Declaration
public void ScrollIntoView(object item)
Parameters
Type Name Description
System.Object item

The item.

SetContainer(UIElement, UIElement)

Sets the container.

Declaration
protected override void SetContainer(UIElement itemContainer, UIElement contentVisual)
Parameters
Type Name Description
UIElement itemContainer

The item container.
UIElement contentVisual

The content visual.
Overrides

SetSortingCommand(DependencyObject, ICommand)

Sets the sorting command.

Declaration
public static void SetSortingCommand(DependencyObject obj, ICommand value)
Parameters
Type Name Description
DependencyObject obj

The object.
ICommand value

The value.

SetVirtualizedCacheMaxRows(DependencyObject, Int32)

Sets the virtualized cache maximum rows.

Declaration
public static void SetVirtualizedCacheMaxRows(DependencyObject obj, int value)
Parameters
Type Name Description
DependencyObject obj

The object.
System.Int32 value

The value.

Events

Sorting

Occurs when [sorting].

Declaration
public event DataGridSortingEventHandler Sorting
Event Type
Type Description
DataGridSortingEventHandler