Class GridTimeSpanColumn

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

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

Constructors

GridTimeSpanColumn()

Initializes a new instance of the GridTimeSpanColumn class.

Declaration
public GridTimeSpanColumn()

Fields

AllowNullProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.AllowNull dependency property.

Declaration
public static readonly DependencyProperty AllowNullProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.AllowNull dependency property.

AllowScrollingOnCircleProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.AllowScrollingOnCircle dependency property.

Declaration
public static readonly DependencyProperty AllowScrollingOnCircleProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.AllowScrollingOnCircle dependency property.

FormatProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.Format dependency property.

Declaration
public static readonly DependencyProperty FormatProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.Format dependency property.

MaxValueProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.MaxValue dependency property.

Declaration
public static readonly DependencyProperty MaxValueProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.MaxValue dependency property.

MinValueProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.MinValue dependency property.

Declaration
public static readonly DependencyProperty MinValueProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.MinValue dependency property.

NullTextProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.NullText dependency property.

Declaration
public static readonly DependencyProperty NullTextProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.NullText dependency property.

ShowArrowButtonsProperty

Identifies the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.ShowArrowButtons dependency property.

Declaration
public static readonly DependencyProperty ShowArrowButtonsProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the Syncfusion.UI.Xaml.Grid.GridTimeSpanColumn.ShowArrowButtons dependency property.

Properties

AllowNull

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

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

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

AllowScrollingOnCircle

Gets or sets a value that indicates whether the user can change the cell values using mouse wheel or up and down arrow key.

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

true if the cell value is changed using the mouse wheel or up and down arrow key; otherwise , false. The default value is true.

Format

Gets or sets a string that specifies to format the time span value.

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

A string that specifies the format the time span value. The default format is ""d:h:m:s".

MaxValue

Gets or sets the maximum value allowed for GridTimeSpanColumn.

Declaration
public TimeSpan MaxValue { get; set; }
Property Value
Type Description
System.TimeSpan

A System.TimeSpan representing the maximum time span value for GridTimeSpanColumn.

MinValue

Gets or sets the minimum value allowed for GridTimeSpanColumn.

Declaration
public TimeSpan MinValue { get; set; }
Property Value
Type Description
System.TimeSpan

A System.TimeSpan representing the minimum time span value for GridTimeSpanColumn.

NullText

Gets or sets a string that is displayed instead of null value if the cell contains null value.

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

A string that is displayed instead of null value in the cell.
Remarks

The NullText is applied ,when the AllowNull property is enabled.

ShowArrowButtons

Gets or sets a value that indicates whether to show the arrow button control.

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

true if the arrow button is used to adjust the time span value ; otherwise , false. The default value is true.

Methods

CanAllowSpinOnMouseScroll()

Determines whether the cell value is rotated using mouse wheel or up and down arrow key is pressed.

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

Returns true if the cell value can be rotated using mouse wheel or up and down arrow key; otherwise false .
Overrides

SetDisplayBindingConverter()

Sets the converter for the of column.

Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks

You can override this method to specify the converter for .

UpdateBindingBasedOnAllowEditing()

Updates the binding for the AllowEdit property changes in the GridTimeSpanColumn.

Declaration
protected override void UpdateBindingBasedOnAllowEditing()
Overrides

Implements

System.IDisposable