Class TreeGridNumericColumn

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

Inheritance
System.Object
ColumnBase<SfGridBase>
GridColumnBase
TreeGridColumn
TreeGridTextColumnBase
TreeGridNumericColumn
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class TreeGridNumericColumn : TreeGridTextColumnBase, IDisposable, IFilterDefinition
Examples
<syncfusion:SfTreeGrid x:Name="treeGrid" AutoGenerateColumns="False" ItemsSource="{Binding Orders}" >
  <syncfusion:SfTreeGrid.Columns>
    <syncfusion:TreeGridNumericColumn
                                   HeaderText="Order ID"
                                   MappingName="OrderID"                                   
  </syncfusion:SfTreeGrid.Columns>
</syncfusion:SfTreeGrid>

Constructors

TreeGridNumericColumn()

Initializes a new instance of the TreeGridNumericColumn class.

Declaration
public TreeGridNumericColumn()

Fields

AllowNullProperty

Identifies the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.AllowNull dependency property.

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

The identifier for the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.AllowNull dependency property.

DisplayNumberFormatProperty

Identifies the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.DisplayNumberFormat dependency property.

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

The identifier for the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.DisplayNumberFormat dependency property.

MaxValueProperty

Identifies the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.MaxValue dependency property.

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

The identifier for the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.MaxValue dependency property.

MinValueProperty

Identifies the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.MinValue dependency property.

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

The identifier for the Syncfusion.UI.Xaml.TreeGrid.GridNumericColumn.MinValue dependency property.

NumberFormatterProperty

Identifies the NumberFormatter dependency property.

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

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

UpDownPlacementModeProperty

Identifies the UpDownPlacementMode dependency property.

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

The identifier for the UpDownPlacementMode dependency property.

Properties

AllowNull

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

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 true.

DisplayNumberFormat

Gets or sets the format used to specify the formatting of numeric value/>.

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

The default value is null.
Remarks

Change the display format of the Value using DisplayNumberFormat or NumberFormatter. When both NumberFormatter and CustomFomat are specified, DisplayNumberFormat will take higher precedence than NumberFormatter. NumberFormatter.

MaxValue

Gets or sets the maximum numerical value that can be selected in the column.

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

The maximum allowed value for the GridNumericColumn. The default value is double.MaxValue.

MinValue

Gets or sets the minimum numerical value that can be selected in the column.

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

The minimum allowed value for the GridNumericColumn The default value is double.MinValue.

NumberFormatter

Gets or sets the number formatter used to specify the formatting of numeric value/>.

Declaration
public INumberFormatter NumberFormatter { get; set; }
Property Value
Type Description
Windows.Globalization.NumberFormatting.INumberFormatter

The default value is null.
Remarks

Change the display format of the Value using NumberFormatter or DisplayNumberFormat. When both NumberFormatter and CustomFomat are specified, DisplayNumberFormat will take higher precedence than NumberFormatter. DisplayNumberFormat.

PlaceholderText

Gets or sets the text that is displayed in the cell until the value 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 "Enter a value".
Examples
<syncfuion:GridNumericColumn MappingName="Quantity" PlaceholderText ="Value" />

UpDownPlacementMode

Gets or sets a value that indicates the placement of up/down buttons used to increment or decrement the numeric value.

Declaration
public NumberBoxUpDownPlacementMode UpDownPlacementMode { get; set; }
Property Value
Type Description
NumberBoxUpDownPlacementMode

Default value is Hidden.

Methods

SetDisplayBindingConverter()

Sets the converter for theDisplayBinding of column.

Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks

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

Implements

System.IDisposable