DataGridCheckBoxColumn.PrepareCellForEdit Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Called when a cell in the column enters editing mode.

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls.Data (in System.Windows.Controls.Data.dll)

Syntax

'Declaration
Protected Overrides Function PrepareCellForEdit ( _
    editingElement As FrameworkElement, _
    editingEventArgs As RoutedEventArgs _
) As Object
protected override Object PrepareCellForEdit(
    FrameworkElement editingElement,
    RoutedEventArgs editingEventArgs
)

Parameters

Return Value

Type: System.Object
The unedited value.

Remarks

The DataGrid control calls the PrepareCellForEdit method when a cell in a column derived from DataGridColumn enters editing mode. The DataGridCheckBoxColumn class overrides this method to respond immediately to the user gesture by updating the value in the hosted CheckBox control. This immediate response is necessary because a DataGridCheckBoxColumn cell enters edit mode with the same user gesture that changes the state of its hosted CheckBox.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

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