DataGridCheckBoxColumn Class

Definition

Represents a DataGrid column that hosts CheckBox controls in its cells.

[Windows.UI.Xaml.StyleTypedProperty(Property="ElementStyle", StyleTargetType=typeof(Windows.UI.Xaml.Controls.CheckBox))]
[Windows.UI.Xaml.StyleTypedProperty(Property="EditingElementStyle", StyleTargetType=typeof(Windows.UI.Xaml.Controls.CheckBox))]
public class DataGridCheckBoxColumn : Microsoft.Toolkit.Uwp.UI.Controls.DataGridBoundColumn
[<Windows.UI.Xaml.StyleTypedProperty(Property="ElementStyle", StyleTargetType=typeof(Windows.UI.Xaml.Controls.CheckBox))>]
[<Windows.UI.Xaml.StyleTypedProperty(Property="EditingElementStyle", StyleTargetType=typeof(Windows.UI.Xaml.Controls.CheckBox))>]
type DataGridCheckBoxColumn = class
    inherit DataGridBoundColumn
Public Class DataGridCheckBoxColumn
Inherits DataGridBoundColumn
Inheritance
Windows.UI.Xaml.DependencyObject
DataGridCheckBoxColumn
Attributes
Windows.UI.Xaml.StyleTypedPropertyAttribute

Constructors

DataGridCheckBoxColumn()

Initializes a new instance of the DataGridCheckBoxColumn class.

Properties

ActualWidth

Gets the actual visible width after Width, MinWidth, and MaxWidth setting at the Column level and DataGrid level have been taken into account.

(Inherited from DataGridColumn)
Binding

Gets or sets the binding that associates the column with a property in the data source.

(Inherited from DataGridBoundColumn)
CanUserReorder

Gets or sets a value indicating whether the user can change the column display position by dragging the column header.

(Inherited from DataGridColumn)
CanUserResize

Gets or sets a value indicating whether the user can adjust the column width using the mouse.

(Inherited from DataGridColumn)
CanUserSort

Gets or sets a value indicating whether the user can sort the column by clicking the column header.

(Inherited from DataGridColumn)
CellStyle

Gets or sets the style that is used when rendering cells in the column.

(Inherited from DataGridColumn)
ClipboardContentBinding

Gets or sets the binding that will be used to get or set cell content for the clipboard. If the base ClipboardContentBinding is not explicitly set, this will return the value of Binding.

(Inherited from DataGridBoundColumn)
DisplayIndex

Gets or sets the display position of the column relative to the other columns in the DataGrid.

(Inherited from DataGridColumn)
DragIndicatorStyle

Gets or sets the style for the drag indicator.

(Inherited from DataGridColumn)
EditingElementStyle

Gets or sets the style that is used when rendering the element that the column displays for a cell in editing mode.

(Inherited from DataGridBoundColumn)
ElementStyle

Gets or sets the style that is used when rendering the element that the column displays for a cell that is not in editing mode.

(Inherited from DataGridBoundColumn)
Header

Gets or sets the header object.

(Inherited from DataGridColumn)
HeaderStyle

Gets or sets the style for the header.

(Inherited from DataGridColumn)
IsAutoGenerated

Gets a value indicating whether this column is autoGenerated.

(Inherited from DataGridColumn)
IsFrozen

Gets a value indicating whether this column is frozen.

(Inherited from DataGridColumn)
IsReadOnly

Gets or sets a value indicating whether this column is read-only.

(Inherited from DataGridColumn)
IsThreeState

Gets or sets a value indicating whether the hosted CheckBox controls allow three states or two.

MaxWidth

Gets or sets the column's maximum width.

(Inherited from DataGridColumn)
MinWidth

Gets or sets the column's minimum width.

(Inherited from DataGridColumn)
SortDirection

Gets or sets the column's sort direction. Null indicates no sorting.

(Inherited from DataGridColumn)
Tag

Gets or sets an object associated with this column.

(Inherited from DataGridColumn)
Visibility

Gets or sets the column's visibility.

(Inherited from DataGridColumn)
Width

Gets or sets the column's width.

(Inherited from DataGridColumn)

Methods

CancelCellEdit(FrameworkElement, Object)

Causes the column cell being edited to revert to the specified value.

GenerateEditingElement(DataGridCell, Object)

Gets a CheckBox control that is bound to the column's Binding property value.

GenerateElement(DataGridCell, Object)

Gets a read-only CheckBox control that is bound to the column's Binding property value.

GetCellContent(DataGridRow)

Returns the column's content for the provided row.

(Inherited from DataGridColumn)
GetCellContent(Object)

Returns the column's content for the provided row dataItem.

(Inherited from DataGridColumn)
NotifyPropertyChanged(String)

Called by a specific column type when one of its properties changed, and its current cells need to be updated.

(Inherited from DataGridColumn)
PrepareCellForEdit(FrameworkElement, RoutedEventArgs)

Called when a cell in the column enters editing mode.

RefreshCellContent(FrameworkElement, Brush, String)

Called by the DataGrid control when this column asks for its elements to be updated, because its CheckBoxContent or IsThreeState property changed.

RefreshForeground(FrameworkElement, Brush)

Called when the computed foreground of a row changed.

Applies to