Export (0) Print
Expand All
1 out of 3 rated this helpful - Rate this topic

DataGridCheckBoxColumn Class

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

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls.Data (in System.Windows.Controls.Data.dll)
[StyleTypedPropertyAttribute(Property = "EditingElementStyle", StyleTargetType = typeof(CheckBox))]
[StyleTypedPropertyAttribute(Property = "ElementStyle", StyleTargetType = typeof(CheckBox))]
public class DataGridCheckBoxColumn : DataGridBoundColumn
<sdk:DataGridCheckBoxColumn />

The DataGridCheckBoxColumn type exposes the following members.

  NameDescription
Public methodDataGridCheckBoxColumnInitializes a new instance of the DataGridCheckBoxColumn class.
Top
  NameDescription
Public propertyActualWidthGets the current width of the column in pixels. (Inherited from DataGridColumn.)
Public propertyBindingGets or sets the binding that associates the column with a property in the data source. (Inherited from DataGridBoundColumn.)
Public propertyCanUserReorderGets or sets a value that indicates whether the user can change the column display position by dragging the column header. (Inherited from DataGridColumn.)
Public propertyCanUserResizeGets or sets a value that indicates whether the user can adjust the column width using the mouse. (Inherited from DataGridColumn.)
Public propertyCanUserSortGets or sets a value that indicates whether the user can sort the column by clicking the column header. (Inherited from DataGridColumn.)
Public propertyCellStyleGets or sets the style that is used when rendering cells in the column. (Inherited from DataGridColumn.)
Public propertyClipboardContentBindingGets or sets the binding that provides access to cell contents for clipboard operations. (Inherited from DataGridBoundColumn.)
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyDisplayIndexGets or sets the display position of the column relative to the other columns in the DataGrid. (Inherited from DataGridColumn.)
Public propertyDragIndicatorStyleGets or sets the style that is used to render the column while it is being dragged. (Inherited from DataGridColumn.)
Public propertyEditingElementStyleGets or sets the style that is used when rendering the element that the column displays for a cell in editing mode. (Inherited from DataGridBoundColumn.)
Public propertyElementStyleGets 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.)
Public propertyHeaderGets or sets the content of the column header. (Inherited from DataGridColumn.)
Public propertyHeaderStyleGets or sets the style that is used when rendering the column header. (Inherited from DataGridColumn.)
Public propertyIsAutoGeneratedGets a value that indicates whether the column is auto-generated. (Inherited from DataGridColumn.)
Public propertyIsFrozenGets a value that indicates whether the column is prevented from scrolling horizontally. (Inherited from DataGridColumn.)
Public propertyIsReadOnlyGets or sets a value that indicates whether cells in the column can be edited. (Inherited from DataGridColumn.)
Public propertyIsThreeStateGets or sets a value that indicates whether the hosted CheckBox controls allow three states or two.
Public propertyMaxWidthGets or sets the maximum column width in pixels. (Inherited from DataGridColumn.)
Public propertyMinWidthGets or sets the minimum column width in pixels. (Inherited from DataGridColumn.)
Public propertySortMemberPathGets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by. (Inherited from DataGridColumn.)
Public propertyVisibilityGets or sets the visibility of the column. (Inherited from DataGridColumn.)
Public propertyWidthGets or sets the column width or an automatic sizing mode. (Inherited from DataGridColumn.)
Top
  NameDescription
Protected methodCancelCellEditCauses the column cell being edited to revert to the specified value. (Overrides DataGridColumn.CancelCellEdit(FrameworkElement, Object).)
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGenerateEditingElementGets a CheckBox control that is bound to the column's Binding property value. (Overrides DataGridColumn.GenerateEditingElement(DataGridCell, Object).)
Protected methodGenerateElementGets a read-only CheckBox control that is bound to the column's Binding property value. (Overrides DataGridColumn.GenerateElement(DataGridCell, Object).)
Public methodGetAnimationBaseValueReturns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetCellContent(DataGridRow)Gets the Content property value for the cell at the intersection of this column and the specified row. (Inherited from DataGridColumn.)
Public methodGetCellContent(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.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodNotifyPropertyChangedCalled by a specific column type when one of its properties changes and its current cells need to be updated. (Inherited from DataGridColumn.)
Protected methodPrepareCellForEditCalled when a cell in the column enters editing mode. (Overrides DataGridColumn.PrepareCellForEdit(FrameworkElement, RoutedEventArgs).)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Protected methodRefreshCellContentRefreshes the contents of a cell in the column in response to a column property value change. (Overrides DataGridColumn.RefreshCellContent(FrameworkElement, String).)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

By default, the DataGrid control generates columns automatically when you set the ItemsSource property. The generated columns are of type DataGridCheckBoxColumn for bound Boolean (and nullable Boolean) properties, and of type DataGridTextColumn for all other properties.

The following code example demonstrates how to specify and configure a DataGridCheckBoxColumn in XAML. This example is part of a larger example available in the DataGrid class overview.


<sdk:DataGrid x:Name="dataGrid4" 
    Height="160" Margin="0,5,0,10" 
    RowHeight="40" AutoGenerateColumns="False" >    
    <sdk:DataGrid.Columns>
        <sdk:DataGridTextColumn 
            Header="First Name" 
            Width="SizeToHeader"
            Binding="{Binding FirstName}" 
            FontSize="20" />
        <sdk:DataGridTextColumn 
            Header="Last Name" 
            Width="SizeToCells"
            Binding="{Binding LastName}" 
            FontSize="20" />
        <sdk:DataGridTextColumn 
            Header="Address"
            Width="150"
            Binding="{Binding Address}" >
            <sdk:DataGridTextColumn.ElementStyle>
                <Style TargetType="TextBlock">
                    <Setter Property="TextWrapping" Value="Wrap"/>
                </Style>
            </sdk:DataGridTextColumn.ElementStyle>
            <sdk:DataGridTextColumn.EditingElementStyle>
                <Style TargetType="TextBox">
                    <Setter Property="Foreground" Value="Blue"/>
                </Style>
            </sdk:DataGridTextColumn.EditingElementStyle>
        </sdk:DataGridTextColumn>
        <sdk:DataGridCheckBoxColumn 
            Header="New?" 
            Width="40"
            Binding="{Binding IsNew}" />
        <sdk:DataGridCheckBoxColumn 
            Header="Subscribed?" 
            Width="Auto"
            Binding="{Binding IsSubscribed}" 
            IsThreeState="True" />
    </sdk:DataGrid.Columns>
</sdk:DataGrid>


Silverlight

Supported in: 5, 4, 3

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.