Class GridCheckBoxColumn
Represents a column that displays and edits Boolean values by hosting a CheckBox as the cell content.
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class GridCheckBoxColumn : GridColumn, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinitionRemarks
Use GridCheckBoxColumn when the column should render Boolean data as a CheckBox. The column supports horizontal alignment and tri-state values.
Constructors
GridCheckBoxColumn()
Initializes a new instance of the GridCheckBoxColumn class.
Declaration
public GridCheckBoxColumn()Fields
HorizontalAlignmentProperty
Identifies the HorizontalAlignment dependency property.
Declaration
public static readonly DependencyProperty HorizontalAlignmentPropertyField Value
| Type |
|---|
| Microsoft.UI.Xaml.DependencyProperty |
Remarks
The identifier for the HorizontalAlignment dependency property.
IsThreeStateProperty
Identifies the IsThreeStateProperty dependency property.
Declaration
public static readonly DependencyProperty IsThreeStatePropertyField Value
| Type |
|---|
| Microsoft.UI.Xaml.DependencyProperty |
Remarks
The identifier for the IsThreeStateProperty dependency property.
Properties
HorizontalAlignment
Gets or sets the horizontal alignment for the CheckBox content in the column.
Declaration
public HorizontalAlignment HorizontalAlignment { get; set; }Property Value
| Type | Description |
|---|---|
| Microsoft.UI.Xaml.HorizontalAlignment | One of the Microsoft.UI.Xaml.HorizontalAlignment values that specifies the horizontal alignment. The default value is Microsoft.UI.Xaml.HorizontalAlignment.Center. |
IsThreeState
Gets or sets a value that indicates whether the CheckBox supports the intermediate state in addition to the checked and unchecked states.
Declaration
public bool IsThreeState { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | true if the intermediate state is enabled in GridCheckBoxColumn; otherwise, false. The default value is false. |
Methods
CanEndEditColumn()
Determines whether the GridCheckBoxColumn can EndEdit or not.
Declaration
protected override bool CanEndEditColumn()Returns
| Type | Description |
|---|---|
| System.Boolean | By default, returns true. |
Overrides
OnCellTemplateChanged(DependencyPropertyChangedEventArgs)
Invoked when the CellTemplate dependency property value changed in the GridCheckBoxColumn.
Declaration
protected override void OnCellTemplateChanged(DependencyPropertyChangedEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs | e | The Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs that contains data for CellTemplate dependency property changes. |
Overrides
UpdateBindingBasedOnAllowEditing()
Updates the binding for the AllowEdit property changes in the GridCheckBoxColumn.
Declaration
protected override void UpdateBindingBasedOnAllowEditing()