Class GridDateColumn

Represents a column that displays the date values in its cell content.

Inheritance
System.Object
ColumnBase<SfGridBase>
GridColumnBase
GridColumn
GridTextColumnBase
GridDateColumn
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class GridDateColumn : GridTextColumnBase, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinition
Examples
<syncfusion:SfDataGrid x:Name="dataGrid" AutoGenerateColumns="False" ItemsSource="{Binding Orders}" >
  <syncfusion:SfDataGrid.Columns>
    <syncfusion:GridDateColumn
                                   HeaderText="Order Date"
                                   MappingName="OrderDate"                                   
  </syncfusion:SfDataGrid.Columns>
</syncfusion:SfDataGrid>

Constructors

GridDateColumn()

Initializes a new instance of GridDateColumn class.

Declaration
public GridDateColumn()

Fields

AllowNullProperty

Identifies the AllowNull dependency property.

Declaration
public static readonly DependencyProperty AllowNullProperty
Field Value
Type Description
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the AllowNull dependency property.

DisplayDateFormatProperty

Identifies the DisplayDateFormat dependency property.

Declaration
public static readonly DependencyProperty DisplayDateFormatProperty
Field Value
Type Description
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the DisplayDateFormat dependency property.

EditModeProperty

Identifies DateTimeEditMode dependency property.

Declaration
public static readonly DependencyProperty EditModeProperty
Field Value
Type Description
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the DateTimeEditMode dependency property.

MaxDateProperty

Identifies the MaxDate dependency property.

Declaration
public static readonly DependencyProperty MaxDateProperty
Field Value
Type Description
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the MaxDate dependency property.

MinDateProperty

Identifies the MinDate dependency property.

Declaration
public static readonly DependencyProperty MinDateProperty
Field Value
Type Description
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the MinDate dependency property.

PlaceholderTextProperty

Identifies the PlaceholderText dependency property.

Declaration
public static readonly DependencyProperty PlaceholderTextProperty
Field Value
Type Description
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the PlaceholderText dependency property.

Properties

AllowNull

Gets or sets a value that indicates whether the null values are allowed in GridDateColumn.

Declaration
public bool AllowNull { get; set; }
Property Value
Type Description
System.Boolean

true if the null values are allowed in GridDateColumn; otherwise, false. The default value is true.
Examples
sfDataGrid.Columns.Add(new GridDateColumn() { MappingName = "Date" , AllowNull = true });

DisplayDateFormat

Gets or sets a string that specifies how to format the bounded value in GridDateColumn.

Declaration
public string DisplayDateFormat { get; set; }
Property Value
Type Description
System.String

A string that specifies how to format the bound value in GridDateColumn. The default value is d.
Examples
<syncfuion:GridDateColumn MappingName="Date1" DisplayDateFormat ="D" />

EditMode

Gets or sets a value that specifies the edit mode to validate the input as per GridDateColumn.DisplayDateFormat format.

Declaration
public DateTimeEditMode EditMode { get; set; }
Property Value
Type Description
DateTimeEditMode

One of the DateTimeEditMode enumeration that specifies how the input numbers on the editor should be validated as per GridDateColumn.DisplayDateFormat property. The default value is Mask.
Remarks

Disable editing using DateTimeEditMode.None. Validate input as you type using DateTimeEditMode.Mask. Validate input when pressing enter key or when editor’s focus is lost using DateTimeEditMode.Normal.

Examples
<syncfuion:GridDateColumn MappingName="Date1" EditMode ="Mask" />

MaxDate

Gets or sets the maximum date and time that can be selected in GridDateColumn.

Declaration
public DateTimeOffset MaxDate { get; set; }
Property Value
Type Description
System.DateTimeOffset

The maximum date and time that can be selected in GridDateColumn. The default value is 12/31/1920.
Remarks

A SfCalendarDatePicker control is loaded in the record cells of the GridDateColumn. It enables you to scroll through a list of dates between the MinDate and MaxDate and select one from it.

Examples
sfDataGrid.Columns.Add(new GridDateColumn() { MappingName = "Date" , MaxDate= new DateTimeOffset(new DateTime(2021, 01, 06)) });
See Also

MinDate

Gets or sets the minimum date and time that can be selected in GridDateColumn.

Declaration
public DateTimeOffset MinDate { get; set; }
Property Value
Type Description
System.DateTimeOffset

The minimum date and time that can be selected in GridDateColumn. The default value is 1/1/1920.
Remarks

A SfCalendarDatePicker control is loaded in the record cells of the GridDateColumn. It enables you to scroll through a list of dates between the MinDate and MaxDate and select one from it.

Examples
sfDataGrid.Columns.Add(new GridDateColumn() { MappingName = "Date" , MinDate= new DateTimeOffset(new DateTime(2000, 01, 06)) });
See Also

PlaceholderText

Gets or sets the text that is displayed in the editor until the SelectedDate is changed by a user action or some other operation.

Declaration
public string PlaceholderText { get; set; }
Property Value
Type Description
System.String

The default value is "select a date".
Examples
<syncfuion:GridDateColumn MappingName="Date1" PlaceholderText ="Date" />

Methods

SetDisplayBindingConverter()

Sets the converter for the DisplayBinding of column.

Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks

You can override this method to specify the converter for DisplayBinding .

Implements

System.IDisposable