Class DataGrid

Namespace

GHIElectronics.Endpoint.UI.Controls

Assembly

GHIElectronics.Endpoint.UI.dll

The DataGrid component is a list-based component that provides a grid of rows and columns.

public class DataGrid : ContentControl

Inheritance

object

DispatcherObject

UIElement

Control

ContentControl

DataGrid

Inherited Members

ContentControl.Child

ContentControl.MeasureOverride(int, int, out int, out int)

Control.Background

Control.Font

Control.Foreground

Control._background

Control._foreground

Control._font

UIElement.OnGenericEvent(GenericEventArgs)

UIElement.OnTouchGestureStarted(TouchGestureEventArgs)

UIElement.OnTouchGestureChanged(TouchGestureEventArgs)

UIElement.OnTouchGestureEnded(TouchGestureEventArgs)

UIElement.OnPreviewButtonDown(ButtonEventArgs)

UIElement.OnButtonDown(ButtonEventArgs)

UIElement.OnPreviewButtonUp(ButtonEventArgs)

UIElement.OnButtonUp(ButtonEventArgs)

UIElement.OnGotFocus(FocusChangedEventArgs)

UIElement.OnLostFocus(FocusChangedEventArgs)

UIElement.TouchDown

UIElement.TouchUp

UIElement.TouchMove

UIElement.TouchGestureStart

UIElement.TouchGestureChanged

UIElement.TouchGestureEnd

UIElement.GetDesiredSize(out int, out int)

UIElement.GetMargin(out int, out int, out int, out int)

UIElement.SetMargin(int)

UIElement.SetMargin(int, int, int, int)

UIElement.ActualWidth

UIElement.ActualHeight

UIElement.Height

UIElement.Width

UIElement.GetLayoutOffset(out int, out int)

UIElement.GetRenderSize(out int, out int)

UIElement.LogicalChildren

UIElement.OnChildrenChanged(UIElement, UIElement, int)

UIElement.IsFocused

UIElement.Measure(int, int)

UIElement.Arrange(int, int, int, int)

UIElement.ArrangeOverride(int, int)

UIElement.UpdateLayout()

UIElement.IsMeasureValid

UIElement.IsArrangeValid

UIElement.ChildElementFromPoint(int, int)

UIElement.GetUnclippedSize(out int, out int)

UIElement.ContainsPoint(int, int)

UIElement.GetPointerTarget(int, int)

UIElement.PointToScreen(ref int, ref int)

UIElement.PointToClient(ref int, ref int)

UIElement.InvalidateMeasure()

UIElement.InvalidateArrange()

UIElement.Parent

UIElement.RootUIElement

UIElement.HorizontalAlignment

UIElement.VerticalAlignment

UIElement.OnChildDesiredSizeChanged(UIElement)

UIElement.Visibility

UIElement.IsVisible

UIElement.IsVisibleChanged

UIElement.IsEnabled

UIElement.IsEnabledChanged

UIElement.RenderRecursive(DrawingContext)

UIElement.InvalidateRect(int, int, int, int)

UIElement.Invalidate()

UIElement.RaiseEvent(RoutedEventArgs)

UIElement.AddToEventRoute(EventRoute, RoutedEventArgs)

UIElement.InstanceEventHandlersStore

UIElement.AddHandler(RoutedEvent, RoutedEventHandler, bool)

UIElement._horizontalAlignment

UIElement._verticalAlignment

DispatcherObject.CheckAccess()

DispatcherObject.VerifyAccess()

DispatcherObject.Dispatcher

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DataGrid(int, int, int, Font)

Creates a new DataGrid component.

public DataGrid(int width, int rowHeight, int rowCount, Font font)

Parameters

width int

width

rowHeight int

rowHeight

rowCount int

rowCount

font Font

font

Properties

Draggable

Indicates whether or not the item list can be dragged up and down.

public bool Draggable { get; set; }

Property Value

bool

GridColor

Grid color.

public Color GridColor { get; set; }

Property Value

Color

HeadersBackColor

Headers background color.

public Color HeadersBackColor { get; set; }

Property Value

Color

HeadersFontColor

Headers font color.

public Color HeadersFontColor { get; set; }

Property Value

Color

ItemsAltBackColor

Items alternate background color.

public Color ItemsAltBackColor { get; set; }

Property Value

Color

ItemsBackColor

Items background color.

public Color ItemsBackColor { get; set; }

Property Value

Color

ItemsFontColor

Items font color.

public Color ItemsFontColor { get; set; }

Property Value

Color

MaxIgnoredTouchMoves

Touch senstitive.

public int MaxIgnoredTouchMoves { get; set; }

Property Value

int

NumItems

Number of items in the DataGrid.

public int NumItems { get; }

Property Value

int

RowCount

Number of rows displayed.

public int RowCount { get; set; }

Property Value

int

RowHeight

Row height.

public int RowHeight { get; set; }

Property Value

int

ScrollbarBackColor

Scrollbar background color.

public Color ScrollbarBackColor { get; set; }

Property Value

Color

ScrollbarScrubberColor

Scrollbar scrubber color.

public Color ScrollbarScrubberColor { get; set; }

Property Value

Color

ScrollbarWidth

Scrollbar width.

public int ScrollbarWidth { get; set; }

Property Value

int

SelectedIndex

The currently selected index.

public int SelectedIndex { get; set; }

Property Value

int

SelectedItemBackColor

Selected item background color.

public Color SelectedItemBackColor { get; set; }

Property Value

Color

SelectedItemFontColor

Selected item font color.

public Color SelectedItemFontColor { get; set; }

Property Value

Color

ShowHeaders

Indicates whether the headers are shown.

public bool ShowHeaders { get; set; }

Property Value

bool

ShowScrollbar

Indicates whether the scrollbar is shown.

public bool ShowScrollbar { get; set; }

Property Value

bool

SortableHeaders

Indicates whether the headers are sortable.

public bool SortableHeaders { get; set; }

Property Value

bool

TappableCells

Indicates whether items trigger cell tap events or not.

public bool TappableCells { get; set; }

Property Value

bool

Methods

AddColumn(DataGridColumn)

Adds a column.

public void AddColumn(DataGridColumn dataGridColumn)

Parameters

dataGridColumn DataGridColumn

dataGridColumn

AddColumnAt(int, DataGridColumn)

Adds a column at a specified index.

public void AddColumnAt(int index, DataGridColumn dataGridColumn)

Parameters

index int

index

dataGridColumn DataGridColumn

dataGridColumn

AddItem(DataGridItem)

Adds an item.

public void AddItem(DataGridItem dataGridItem)

Parameters

dataGridItem DataGridItem

dataGridItem

AddItemAt(int, DataGridItem)

Adds an item at a specified index.

public void AddItemAt(int index, DataGridItem dataGridItem)

Parameters

index int

index

dataGridItem DataGridItem

dataGridItem

Clear()

Clears all items including their data and resets the data grid.

public void Clear()

Dispose()

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

~DataGrid()

protected ~DataGrid()

GetCellData(int, int)

Get a cell's data.

public object GetCellData(int columnIndex, int rowIndex)

Parameters

columnIndex int

columnIndex

rowIndex int

rowIndex

Returns

object

GetRowData(int)

Gets row data.

public object[] GetRowData(int index)

Parameters

index int

index

Returns

object[]

Data object array.

OnRender(DrawingContext)

Renders the DataGrid onto it's parent container's graphics.

public override void OnRender(DrawingContext dc)

Parameters

dc DrawingContext

OnTouchDown(TouchEventArgs)

Handles the touch down event.

protected override void OnTouchDown(TouchEventArgs e)

Parameters

e TouchEventArgs

Touch event arguments.

OnTouchMove(TouchEventArgs)

Handles the touch move event.

protected override void OnTouchMove(TouchEventArgs e)

Parameters

e TouchEventArgs

Touch event arguments.

OnTouchUp(TouchEventArgs)

Handles the touch up event.

protected override void OnTouchUp(TouchEventArgs e)

Parameters

e TouchEventArgs

Touch event arguments.

RemoveColumn(DataGridColumn)

Removes a column.

public void RemoveColumn(DataGridColumn dataGridColumn)

Parameters

dataGridColumn DataGridColumn

dataGridColumn

RemoveColumnAt(int)

Removes a column at a specified index.

public void RemoveColumnAt(int index)

Parameters

index int

index

RemoveItem(DataGridItem)

Removes an item.

public void RemoveItem(DataGridItem dataGridItem)

Parameters

dataGridItem DataGridItem

dataGridItem

RemoveItemAt(int)

Removes an item a specified index.

public void RemoveItemAt(int index)

Parameters

index int

index

ScrollDown(int)

Scroll the rows down by a specified amount.

public void ScrollDown(int amount)

Parameters

amount int

amount

ScrollTo(int)

Scroll the rows to a specified index.

public void ScrollTo(int index)

Parameters

index int

index

ScrollUp(int)

Scroll the rows up by a specified amount.

public void ScrollUp(int amount)

Parameters

amount int

amount

SetCellData(int, int, object)

Sets a cell's data.

public void SetCellData(int columnIndex, int rowIndex, object data)

Parameters

columnIndex int

columnIndex

rowIndex int

rowIndex

data object

data

SetRowData(int, object[])

Sets new row data.

public void SetRowData(int index, object[] data)

Parameters

index int

index

data object[]

Data object array.

Sort(int)

Sorts the items on a specified column index.

public void Sort(int columnIndex)

Parameters

columnIndex int

TriggerTapCellEvent(object, TapCellEventArgs)

Triggers a tap cell event.

public void TriggerTapCellEvent(object sender, DataGrid.TapCellEventArgs args)

Parameters

sender object

Object associated with this event.

args DataGrid.TapCellEventArgs

Tap cell event arguments.

Events

TapCellEvent

Tap grid event.

public event DataGrid.OnTapCell TapCellEvent

Event Type

DataGrid.OnTapCell