WinUI

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridTimeColumn

    Show / Hide Table of Contents

    Class GridTimeColumn

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

    Inheritance
    System.Object
    ColumnBase<SfGridBase>
    GridColumnBase
    GridColumn
    GridTextColumnBase
    GridTimeColumn
    Implements
    System.IDisposable
    INotifyDependencyPropertyChanged
    IFilterDefinition
    Inherited Members
    GridTextColumnBase.TextTrimmingProperty
    GridTextColumnBase.TextWrappingProperty
    GridTextColumnBase.TextTrimming
    GridTextColumnBase.TextWrapping
    GridColumn.FilterRowCellStyleProperty
    GridColumn.UseBindingValueProperty
    GridColumn.ColumnWidthModeProperty
    GridColumn.AllowDraggingProperty
    GridColumn.AllowGroupingProperty
    GridColumn.AllowResizingProperty
    GridColumn.AllowFilteringProperty
    GridColumn.ImmediateUpdateColumnFilterProperty
    GridColumn.FilterRowOptionsVisibilityProperty
    GridColumn.FilterRowConditionProperty
    GridColumn.FilterPopupStyleProperty
    GridColumn.FilterPopupTemplateProperty
    GridColumn.AllowBlankFiltersProperty
    GridColumn.FilterRowTextProperty
    GridColumn.IsCaseSensitiveFilterRowProperty
    GridColumn.GroupModeProperty
    GridColumn.SortModeProperty
    GridColumn.OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs)
    GridColumn.OnCellTemplateChanged(DependencyPropertyChangedEventArgs)
    GridColumn.CanAllowSpinOnMouseScroll()
    GridColumn.Dispose(Boolean)
    GridColumn.GetRowFilterType()
    GridColumn.GetFilterRowOptionsVisibility()
    GridColumn.SetCellType(String)
    GridColumn.CanFocus()
    GridColumn.IsHiddenColumn()
    GridColumn.CanEditCell(Int32)
    GridColumn.CanEndEditColumn()
    GridColumn.UpdateBindingBasedOnAllowEditing()
    GridColumn.SetFilterRowText(String)
    GridColumn.OnDependencyPropertyChanged(String, DependencyPropertyChangedEventArgs)
    GridColumn.ColumnMemberType
    GridColumn.FilterRowCellStyle
    GridColumn.UseBindingValue
    GridColumn.ColumnWidthMode
    GridColumn.AllowDragging
    GridColumn.AllowGrouping
    GridColumn.AllowResizing
    GridColumn.AllowFiltering
    GridColumn.ImmediateUpdateColumnFilter
    GridColumn.FilterRowOptionsVisibility
    GridColumn.FilterRowCondition
    GridColumn.FilterPopupStyle
    GridColumn.FilterPopupTemplate
    GridColumn.AllowBlankFilters
    GridColumn.FilterRowText
    GridColumn.IsCaseSensitiveFilterRow
    GridColumn.GroupMode
    GridColumn.SortMode
    GridColumn.CellType
    GridColumn.FilteredFrom
    GridColumn.DataGrid
    GridColumn.FilterPredicates
    GridColumn.FilterBehavior
    GridColumn.ColumnFilter
    GridColumn.FilterRowEditorType
    GridColumnBase.ActualWidthProperty
    GridColumnBase.MappingNameProperty
    GridColumnBase.HeaderTextProperty
    GridColumnBase.AllowEditingProperty
    GridColumnBase.IsReadOnlyProperty
    GridColumnBase.DataValidationModeProperty
    GridColumnBase.UpdateTriggerProperty
    GridColumnBase.PaddingProperty
    GridColumnBase.AllowFocusProperty
    GridColumnBase.HeaderTemplateProperty
    GridColumnBase.CellTemplateProperty
    GridColumnBase.SetCellBoundValueProperty
    GridColumnBase.CellTemplateSelectorProperty
    GridColumnBase.CellStyleProperty
    GridColumnBase.CellStyleSelectorProperty
    GridColumnBase.HeaderStyleProperty
    GridColumnBase.AllowSortingProperty
    GridColumnBase.VerticalAlignmentProperty
    GridColumnBase.TextAlignmentProperty
    GridColumnBase.HorizontalHeaderContentAlignmentProperty
    GridColumnBase.WidthProperty
    GridColumnBase.IsHiddenProperty
    GridColumnBase.MaximumWidthProperty
    GridColumnBase.MinimumWidthProperty
    GridColumnBase.ShowHeaderToolTipProperty
    GridColumnBase.ToolTipTemplateProperty
    GridColumnBase.HeaderToolTipTemplateProperty
    GridColumnBase.ToolTipTemplateSelectorProperty
    GridColumnBase.ShowToolTipProperty
    GridColumnBase.SetCellBoundToolTipProperty
    GridColumnBase.OnUpdateBindingInfo(DependencyObject, DependencyPropertyChangedEventArgs)
    GridColumnBase.SetValueBindingConverter()
    GridColumnBase.CanEditCell()
    GridColumnBase.UpdateBindingForValidation(GridValidationMode)
    GridColumnBase.IsAutoGenerated
    GridColumnBase.IsTemplate
    GridColumnBase.ActualWidth
    GridColumnBase.MappingName
    GridColumnBase.HeaderText
    GridColumnBase.AllowEditing
    GridColumnBase.IsReadOnly
    GridColumnBase.DataValidationMode
    GridColumnBase.UpdateTrigger
    GridColumnBase.Padding
    GridColumnBase.AllowFocus
    GridColumnBase.HeaderTemplate
    GridColumnBase.CellTemplate
    GridColumnBase.SetCellBoundValue
    GridColumnBase.CellTemplateSelector
    GridColumnBase.CellStyle
    GridColumnBase.CellStyleSelector
    GridColumnBase.HeaderStyle
    GridColumnBase.AllowSorting
    GridColumnBase.VerticalAlignment
    GridColumnBase.TextAlignment
    GridColumnBase.HorizontalHeaderContentAlignment
    GridColumnBase.Width
    GridColumnBase.IsHidden
    GridColumnBase.MaximumWidth
    GridColumnBase.MinimumWidth
    GridColumnBase.ValueBinding
    GridColumnBase.DisplayBinding
    GridColumnBase.ShowHeaderToolTip
    GridColumnBase.ToolTipTemplate
    GridColumnBase.HeaderToolTipTemplate
    GridColumnBase.ToolTipTemplateSelector
    GridColumnBase.ShowToolTip
    GridColumnBase.SetCellBoundToolTip
    ColumnBase<SfGridBase>.Dispose()
    Namespace: Syncfusion.UI.Xaml.DataGrid
    Assembly: Syncfusion.Grid.WinUI.dll
    Syntax
    public class GridTimeColumn : GridTextColumnBase, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinition
    Examples
    <syncfusion:SfDataGrid x:Name="dataGrid" AutoGenerateColumns="False" ItemsSource="{Binding Orders}" >
      <syncfusion:SfDataGrid.Columns>
        <syncfusion:GridTimeColumn
                                       HeaderText="Order Time"
                                       MappingName="OrderTime"                                   
      </syncfusion:SfDataGrid.Columns>
    </syncfusion:SfDataGrid>

    Constructors

    GridTimeColumn()

    Initializes a new instance of GridTimeColumn class.

    Declaration
    public GridTimeColumn()

    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.

    DisplayTimeFormatProperty

    Identifies the DisplayTimeFormat dependency property.

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

    The identifier for the DisplayTimeFormat 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.

    MaxTimeProperty

    Identifies the MaxTime dependency property.

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

    The identifier for the MaxTime dependency property.

    MinTimeProperty

    Identifies the MinTime dependency property.

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

    The identifier for the MinTime 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.

    ShowSubmitButtonsProperty

    Identifies ShowSubmitButtons dependency property.

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

    The identifier for the ShowSubmitButtons dependency property.

    Properties

    AllowNull

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

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

    true if the null values are allowed in GridTimeColumn; otherwise, false. The default value is true.

    Examples
    sfDataGrid.Columns.Add(new GridTimeColumn() { MappingName = "OrderTime" , AllowNull = false });

    DisplayTimeFormat

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

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

    A string that specifies how to format the bound value in GridTimeColumn. The default value is hh:mm tt.

    Examples
    <syncfusion:GridTimeColumn MappingName="OrderTime" DisplayTimeFormat ="HH:mm:ss" />

    EditMode

    Gets or sets a value that specifies the edit mode to validate the input as per GridTimeColumn.DisplayTimeFormat 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 GridTimeColumn.DisplayTimeFormat 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:GridTimeColumn MappingName="OrderTime" EditMode ="Normal" />

    MaxTime

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

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

    The maximum date and time that can be selected in GridTimeColumn. The default value is 2121,12,31 DateTimeOffset.Now.Hour, DateTimeOffset.Now.Minute, DateTimeOffset.Now.Second, DateTimeOffset.Now.Offset.

    Remarks

    A SfTimePicker control is loaded in the record cells of the GridTimeColumn. It enables you to scroll through a list of times between the MinTime and MaxTime and select one from it.

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

    MinTime

    Gets or sets the minimum time that can be selected in GridTimeColumn.

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

    The minimum time that can be selected in GridTimeColumn. The default value is 1921, 1, 1, DateTimeOffset.Now.Hour, DateTimeOffset.Now.Minute, DateTimeOffset.Now.Second, DateTimeOffset.Now.Offset.

    Remarks

    A SfTimePicker control is loaded in the record cells of the GridTimeColumn. It enables you to scroll through a list of times between the MinTime and MaxTime and select one from it.

    Examples
    sfDataGrid.Columns.Add(new GridTimeColumn() { MappingName = "OrderTime" , MinTime= new DateTimeOffset(new DateTime(2000, 01, 06,02,45,23)) });
    See Also
    MaxTime

    PlaceholderText

    Gets or sets the text that is displayed in the editor until the SelectedTime 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 time".

    Examples
    <syncfuion:GridTimeColumn MappingName="OrderTime" PlaceholderText ="Select a time" />

    ShowSubmitButtons

    Gets or sets a value indicating whether to show or hide the accept and decline buttons in editor.

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

    true if the submit buttons are visible ; otherwise , false. The default value is true.

    Examples
    <syncfuion:GridTimeColumn MappingName="OrderTime" ShowSubmitButtons ="False" />

    Methods

    SetDisplayBindingConverter()

    Sets the converter for the DisplayBinding of column.

    Declaration
    protected override void SetDisplayBindingConverter()
    Overrides
    GridTextColumnBase.SetDisplayBindingConverter()
    Remarks

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

    Implements

    System.IDisposable
    INotifyDependencyPropertyChanged
    IFilterDefinition
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved