Class GridCheckBoxColumn

Represents a column that used to display and edit boolean values and hosts CheckBox as its cell content.

Inheritance
System.Object
SfGridColumnBase<SfGridBase>
GridColumnBase
GridColumn
GridCheckBoxColumn
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.UWP.dll
Syntax
public class GridCheckBoxColumn : GridColumn, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinition

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 HorizontalAlignmentProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty
Remarks

The identifier for the HorizontalAlignment dependency property.

IsThreeStateProperty

Identifies the IsThreeStateProperty dependency property.

Declaration
public static readonly DependencyProperty IsThreeStateProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty
Remarks

The identifier for the IsThreeStateProperty dependency property.

Properties

HorizontalAlignment

Gets or sets the horizontal alignment for the column .

Declaration
public HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
Type Description
Windows.UI.Xaml.HorizontalAlignment

One of the System.Windows.HorizontalAlignment enumeration that specifies the horizontal alignment. The default value is Microsoft.UI.Xaml.HorizontalAlignment.Center

IsThreeState

Gets or sets a value that indicates whether the user can enable the Intermediate state of the CheckBox other than the Checked and Unchecked state.

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()

Checks whether the column is boolean type or not.

Declaration
protected override bool CanEndEditColumn()
Returns
Type Description
System.Boolean

By default, returns true.
Overrides
Remarks

override this method in corresponding boolean column and returns true.

OnCellTemplateChanged(DependencyPropertyChangedEventArgs)

Invoked when the dependency property value changed in the GridCheckBoxColumn.

Declaration
protected override void OnCellTemplateChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
Windows.UI.Xaml.DependencyPropertyChangedEventArgs e

The 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()
Overrides

Implements

System.IDisposable

Extension Methods