Class GridEditorColumn
Provides the base implementation for all the editor columns in a SfDataGrid.
Implements
Inherited Members
Namespace: Syncfusion.SfDataGrid.XForms
Assembly: Syncfusion.SfDataGrid.XForms.dll
Syntax
public abstract class GridEditorColumn : GridColumn, IDisposable
Constructors
GridEditorColumn()
Initializes a new instance of the GridEditorColumn class.
Declaration
protected GridEditorColumn()
Fields
AllowNullValueProperty
Identifies the AllowNullValue Xamarin.Forms.BindableProperty.
Declaration
public static readonly BindableProperty AllowNullValueProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
Remarks
This Xamarin.Forms.BindableProperty is read-only.
MaxValueProperty
Identifies the MaxValue dependency property.
Declaration
public static readonly BindableProperty MaxValueProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
Remarks
This Xamarin.Forms.BindableProperty is read-only.
MinValueProperty
Identifies the MinValue Xamarin.Forms.BindableProperty.
Declaration
public static readonly BindableProperty MinValueProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
Remarks
This Xamarin.Forms.BindableProperty is read-only.
NullTextProperty
Identifies the NullText dependency property.
Declaration
public static BindableProperty NullTextProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
Remarks
This Xamarin.Forms.BindableProperty is read-only.
NullValueProperty
Identifies the NullValue Xamarin.Forms.BindableProperty.
Declaration
public static readonly BindableProperty NullValueProperty
Field Value
Type |
---|
Xamarin.Forms.BindableProperty |
Remarks
This Xamarin.Forms.BindableProperty is read-only.
Properties
AllowNullValue
Gets or sets a value indicating whether the null values are allowed to the editor columns. When this property is enabled, NullValue or NullText will be set to the column, instead of the null value given by the user in edit mode.
Declaration
public bool AllowNullValue { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the null value is allowed, otherwise false. The default value is false. |
Examples
GridNumericColumn numericColumn = new GridNumericColumn();
numericColumn.AllowNullValue = true;
dataGrid.Columns.Add(numericColumn);
MaxValue
Gets or sets the maximum value constraint of the column.
Declaration
public Decimal MaxValue { get; set; }
Property Value
Type | Description |
---|---|
System.Decimal | The maximum value constraint of the column. |
MinValue
Gets or sets the minimum value constraint of the column.
Declaration
public Decimal MinValue { get; set; }
Property Value
Type | Description |
---|---|
System.Decimal | The minimum value constraint of the column. |
NullText
Gets or sets a string that is displayed instead of null value if the cell value is null, provided that AllowNullValue is enabled.
Declaration
public string NullText { get; set; }
Property Value
Type | Description |
---|---|
System.String | A string that is displayed instead of null value in the cell, provided that the NullValue is null. |
Remarks
The NullText is applied, when the AllowNullValue property is enabled and the NullValue is null.
Examples
GridNumericColumn numericColumn = new GridNumericColumn();
numericColumn.AllowNullValue = true;
numericColumn.NullText = "null";
dataGrid.Columns.Add(numericColumn);
NullValue
Gets or sets an object that is displayed instead of null value if the cell value is null, provided that AllowNullValue is enabled.
Declaration
public object NullValue { get; set; }
Property Value
Type | Description |
---|---|
System.Object | An object that is displayed instead of null value in the cell. |
Remarks
The NullValue is applied, when the AllowNullValue property is enabled.
Examples
GridNumericColumn numericColumn = new GridNumericColumn();
numericColumn.AllowNullValue = true;
numericColumn.NullValue = 0;
dataGrid.Columns.Add(numericColumn);
Methods
GetFormattedValue(Object)
Gets the Formatted value for the Content of a record cell in the column based on the Format and CultureInfo of the column.
Declaration
public override object GetFormattedValue(object value)
Parameters
Type | Name | Description |
---|---|---|
System.Object | value | The actual value of the record cell in the column. |
Returns
Type | Description |
---|---|
System.Object | The formatted value based on the Format and CultureInfo properties of the column. |