DataGridCheckBoxColumn Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public ref class DataGridCheckBoxColumn : System::Windows::Controls::DataGridBoundColumnpublic class DataGridCheckBoxColumn : System.Windows.Controls.DataGridBoundColumntype DataGridCheckBoxColumn = class
inherit DataGridBoundColumnPublic Class DataGridCheckBoxColumn
Inherits DataGridBoundColumn- Inheritance
Examples
The following example shows how to add a DataGridCheckBoxColumn. This example uses a database as the source and displays a column of Boolean data.
<DataGrid Name="DG1" AutoGenerateColumns="False" ItemsSource="{Binding}">
<DataGrid.Columns>
<DataGridCheckBoxColumn Header="Online Order?" IsThreeState="True" Binding="{Binding OnlineOrderFlag}" />
</DataGrid.Columns>
</DataGrid>
Remarks
Use DataGridCheckBoxColumn to display columns of Boolean data as a CheckBox. The following illustration shows an example of DataGridCheckBoxColumn.
To populate the column, bind the column to the data by using the Binding property. The Binding property is applied to the CheckBox element created in the column. The DataContext for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the Binding.Path. Optionally, you can specify a Binding.Converter if your data source and target are different types. For more information about data binding, see Data Binding (WPF).
You can customize the DataGridCheckBoxColumn by setting properties, such as Width, Header, IsThreeState, and IsReadOnly.
If you want to display other types of data, DataGrid provides the following column types:
| Column Type | Data Display |
|---|---|
| DataGridHyperlinkColumn | Use to display URI data. |
| DataGridComboBoxColumn | Use to display enumeration data. |
| DataGridTextColumn | Use to display text. |
If you want to use other controls in your DataGrid, you can create your own column types by using DataGridTemplateColumn.
Constructors
| DataGridCheckBoxColumn() |
Initializes a new instance of the DataGridCheckBoxColumn class. |
Fields
| IsThreeStateProperty |
Identifies the IsThreeState dependency property. |
Properties
| ActualWidth |
Gets the current width of the column, in device-independent units (1/96th inch per unit). (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 that indicates whether the user can change the column display position by dragging the column header. (Inherited from DataGridColumn) |
| CanUserResize |
Gets or sets a value that indicates whether the user can adjust the column width by using the mouse. (Inherited from DataGridColumn) |
| CanUserSort |
Gets or sets a value that indicates whether the user can sort the column by clicking the column header. (Inherited from DataGridColumn) |
| CellStyle |
Gets or sets the style that is used to render cells in the column. (Inherited from DataGridColumn) |
| ClipboardContentBinding |
Gets or sets the binding object to use when getting or setting cell content for the clipboard. (Inherited from DataGridBoundColumn) |
| DataGridOwner |
Gets the DataGrid control that contains this column. (Inherited from DataGridColumn) |
| DefaultEditingElementStyle |
Gets the default value of the EditingElementStyle property. |
| DefaultElementStyle |
Gets the default value of the ElementStyle property. |
| DependencyObjectType |
Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject) |
| Dispatcher |
Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject) |
| 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 object to apply to the column header during a drag operation. (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 content of the column header. (Inherited from DataGridColumn) |
| HeaderStringFormat |
Gets or sets the format pattern to apply to the content of the column header. (Inherited from DataGridColumn) |
| HeaderStyle |
Gets or sets the style that is used when rendering the column header. (Inherited from DataGridColumn) |
| HeaderTemplate |
Gets or sets the template that defines the visual representation of the column header. (Inherited from DataGridColumn) |
| HeaderTemplateSelector |
Gets or sets the object that selects which template to use for the column header. (Inherited from DataGridColumn) |
| IsAutoGenerated |
Gets a value that indicates whether the column is auto-generated. (Inherited from DataGridColumn) |
| IsFrozen |
Gets a value that indicates whether the column is prevented from scrolling horizontally. (Inherited from DataGridColumn) |
| IsReadOnly |
Gets or sets a value that indicates whether cells in the column can be edited. (Inherited from DataGridColumn) |
| IsSealed |
Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject) |
| IsThreeState |
Gets or sets a value that indicates whether the hosted CheckBox controls enable three states or two. |
| MaxWidth |
Gets or sets the maximum width constraint of the column. (Inherited from DataGridColumn) |
| MinWidth |
Gets or sets the minimum width constraint of the column. (Inherited from DataGridColumn) |
| SortDirection |
Gets or sets the sort direction (ascending or descending) of the column. (Inherited from DataGridColumn) |
| SortMemberPath |
Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by. (Inherited from DataGridColumn) |
| Visibility |
Gets or sets the visibility of the column. (Inherited from DataGridColumn) |
| Width |
Gets or sets the column width or automatic sizing mode. (Inherited from DataGridColumn) |
Methods
| CancelCellEdit(FrameworkElement, Object) |
Causes the cell being edited to revert to the original, unedited value. (Inherited from DataGridColumn) |
| CheckAccess() |
Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| ClearValue(DependencyProperty) |
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject) |
| ClearValue(DependencyPropertyKey) |
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject) |
| CoerceValue(DependencyProperty) |
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject) |
| CommitCellEdit(FrameworkElement) |
Performs any required validation before exiting cell editing mode. (Inherited from DataGridColumn) |
| Equals(Object) |
Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject) |
| 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) |
Retrieves the Content property value for the cell at the intersection of this column and the specified row. (Inherited from DataGridColumn) |
| GetCellContent(Object) |
Gets the Content property value for the cell at the intersection of this column and the row that represents the specified data item. (Inherited from DataGridColumn) |
| GetHashCode() |
Gets a hash code for this DependencyObject. (Inherited from DependencyObject) |
| GetLocalValueEnumerator() |
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject) |
| InvalidateProperty(DependencyProperty) |
Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| NotifyPropertyChanged(String) |
Notifies the DataGrid that contains this column that a column property has changed. (Inherited from DataGridColumn) |
| OnBindingChanged(BindingBase, BindingBase) |
Notifies the DataGrid when the value of the Binding property changes. (Inherited from DataGridBoundColumn) |
| OnCoerceIsReadOnly(Boolean) |
Determines the value of the IsReadOnly property based on property rules from the data grid that contains this column. (Inherited from DataGridBoundColumn) |
| OnCopyingCellClipboardContent(Object) |
Raises the CopyingCellClipboardContent event. (Inherited from DataGridColumn) |
| OnPastingCellClipboardContent(Object, Object) |
Raises the PastingCellClipboardContent event. (Inherited from DataGridColumn) |
| OnPropertyChanged(DependencyPropertyChangedEventArgs) |
Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject) |
| PrepareCellForEdit(FrameworkElement, RoutedEventArgs) |
Called when a cell in the column enters editing mode. |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject) |
| RefreshCellContent(FrameworkElement, String) |
Refreshes the contents of a cell in the column in response to a column property value change. |
| SetCurrentValue(DependencyProperty, Object) |
Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject) |
| SetValue(DependencyPropertyKey, Object) |
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject) |
| ShouldSerializeProperty(DependencyProperty) |
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| VerifyAccess() |
Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
Events
| CopyingCellClipboardContent |
Occurs after the cell clipboard content is prepared. (Inherited from DataGridColumn) |
| PastingCellClipboardContent |
Occurs before the clipboard content is moved to the cell. (Inherited from DataGridColumn) |
