Back to all docs
API Reference / Telerik.Maui.Controls / DataFormEditor
New to Telerik UI for .NET MAUI? Start a free 30-day trial

DataFormEditor

Class

Base abstract class for all editors in a RadDataForm.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:
C#
public abstract class DataFormEditor : DataFormItem, IRadContentView, IContentView, IPadding, ICrossPlatformLayout, IView, IElement, ITransform

Inheritance: objectRadContentViewDataFormContentViewDataFormItemDataFormEditor

Derived Classes: DataFormCustomEditorDataFormDatePickerEditorDataFormInputEditorDataFormRadCheckBoxEditorDataFormRadComboBoxEditorDataFormRadNumericEditorDataFormRadPickerEditorDataFormRadSegmentedEditorDataFormSwitchEditorDataFormTimePickerEditor...

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIView...

Inherited Members DataFormContentView.BackgroundColorPropertyDataFormContentView.BorderColorPropertyDataFormContentView.BorderThicknessPropertyDataFormContentView.CornerRadiusPropertyDataFormContentView.ContentPaddingPropertyDataFormContentView.BackgroundColorDataFormContentView.BorderColorDataFormContentView.BorderThicknessDataFormContentView.CornerRadiusDataFormContentView.ContentPaddingRadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnBindingContextChanged()RadContentView.OnHandlerChanged()...

Constructors

DataFormEditor()

Initializes a new instance of the DataFormEditor class.

C#
public DataFormEditor()

Fields

ActualEditorStyleProperty

BindableProperty

Identifies the ActualEditorStyle property.

C#
public static readonly BindableProperty ActualEditorStyleProperty

ActualErrorDisplayOptionsProperty

BindableProperty

Identifies the ActualErrorDisplayOptions property.

C#
public static readonly BindableProperty ActualErrorDisplayOptionsProperty

ActualErrorImageSourceProperty

BindableProperty

Identifies the ActualErrorImageSource property.

C#
public static readonly BindableProperty ActualErrorImageSourceProperty

ActualErrorImageStyleProperty

BindableProperty

Identifies the ActualErrorImageStyle property.

C#
public static readonly BindableProperty ActualErrorImageStyleProperty

ActualErrorLabelStyleProperty

BindableProperty

Identifies the ActualErrorLabelStyle property.

C#
public static readonly BindableProperty ActualErrorLabelStyleProperty

ActualErrorLengthProperty

BindableProperty

Identifies the ActualErrorLength property.

C#
public static readonly BindableProperty ActualErrorLengthProperty

ActualErrorPositionProperty

BindableProperty

Identifies the ActualErrorPosition property.

C#
public static readonly BindableProperty ActualErrorPositionProperty

ActualHeaderDisplayOptionsProperty

BindableProperty

Identifies the ActualHeaderDisplayOptions property.

C#
public static readonly BindableProperty ActualHeaderDisplayOptionsProperty

ActualHeaderImageSourceProperty

BindableProperty

Identifies the ActualHeaderImageSource property.

C#
public static readonly BindableProperty ActualHeaderImageSourceProperty

ActualHeaderImageStyleProperty

BindableProperty

Identifies the ActualHeaderImageStyle property.

C#
public static readonly BindableProperty ActualHeaderImageStyleProperty

ActualHeaderLabelStyleProperty

BindableProperty

Identifies the ActualHeaderLabelStyle property.

C#
public static readonly BindableProperty ActualHeaderLabelStyleProperty

ActualHeaderLengthProperty

BindableProperty

Identifies the ActualHeaderLength property.

C#
public static readonly BindableProperty ActualHeaderLengthProperty

ActualHeaderPositionProperty

BindableProperty

Identifies the ActualHeaderPosition property.

C#
public static readonly BindableProperty ActualHeaderPositionProperty

ColumnSpacingProperty

BindableProperty

Identifies the ColumnSpacing property.

C#
public static readonly BindableProperty ColumnSpacingProperty

CommitModeProperty

BindableProperty

Identifies the CommitMode property.

C#
public static readonly BindableProperty CommitModeProperty

ConverterParameterProperty

BindableProperty

Identifies the ConverterParameter property.

C#
public static readonly BindableProperty ConverterParameterProperty

ConverterProperty

BindableProperty

Identifies the Converter property.

C#
public static readonly BindableProperty ConverterProperty

EditorStyleProperty

BindableProperty

Identifies the EditorStyle property.

C#
public static readonly BindableProperty EditorStyleProperty

EditorValueProperty

BindableProperty

Identifies the EditorValue property.

C#
public static readonly BindableProperty EditorValueProperty

ErrorDisplayOptionsProperty

BindableProperty

Identifies the ErrorDisplayOptions property.

C#
public static readonly BindableProperty ErrorDisplayOptionsProperty

ErrorImageSourceProperty

BindableProperty

Identifies the ErrorImageSource property.

C#
public static readonly BindableProperty ErrorImageSourceProperty

ErrorImageStyleProperty

BindableProperty

Identifies the ErrorImageStyle property.

C#
public static readonly BindableProperty ErrorImageStyleProperty

ErrorLabelStyleProperty

BindableProperty

Identifies the ErrorLabelStyle property.

C#
public static readonly BindableProperty ErrorLabelStyleProperty

ErrorLengthProperty

BindableProperty

Identifies the ErrorLength property.

C#
public static readonly BindableProperty ErrorLengthProperty

ErrorPositionProperty

BindableProperty

Identifies the ErrorPosition property.

C#
public static readonly BindableProperty ErrorPositionProperty

HasPendingChangesProperty

BindableProperty

Identifies the HasPendingChanges property.

C#
public static readonly BindableProperty HasPendingChangesProperty

HasValidationErrorsProperty

BindableProperty

Identifies the HasValidationErrors property.

C#
public static readonly BindableProperty HasValidationErrorsProperty

HeaderDisplayOptionsProperty

BindableProperty

Identifies the HeaderDisplayOptions property.

C#
public static readonly BindableProperty HeaderDisplayOptionsProperty

HeaderImageSourceProperty

BindableProperty

Identifies the HeaderImageSource property.

C#
public static readonly BindableProperty HeaderImageSourceProperty

HeaderImageStyleProperty

BindableProperty

Identifies the HeaderImageStyle property.

C#
public static readonly BindableProperty HeaderImageStyleProperty

HeaderLabelStyleProperty

BindableProperty

Identifies the HeaderLabelStyle property.

C#
public static readonly BindableProperty HeaderLabelStyleProperty

HeaderLengthProperty

BindableProperty

Identifies the HeaderLength property.

C#
public static readonly BindableProperty HeaderLengthProperty

HeaderPositionProperty

BindableProperty

Identifies the HeaderPosition property.

C#
public static readonly BindableProperty HeaderPositionProperty

HeaderTextProperty

BindableProperty

Identifies the HeaderText property.

C#
public static readonly BindableProperty HeaderTextProperty

IsErrorImageVisibleProperty

BindableProperty

Identifies the IsErrorImageVisible property.

C#
public static readonly BindableProperty IsErrorImageVisibleProperty

IsErrorLabelVisibleProperty

BindableProperty

Identifies the IsErrorLabelVisible property.

C#
public static readonly BindableProperty IsErrorLabelVisibleProperty

IsHeaderImageVisibleProperty

BindableProperty

Identifies the IsHeaderImageVisible property.

C#
public static readonly BindableProperty IsHeaderImageVisibleProperty

IsHeaderLabelVisibleProperty

BindableProperty

Identifies the IsHeaderLabelVisible property.

C#
public static readonly BindableProperty IsHeaderLabelVisibleProperty

IsReadOnlyProperty

BindableProperty

Identifies the IsReadOnly property.

C#
public static readonly BindableProperty IsReadOnlyProperty

PropertyNameProperty

BindableProperty

Identifies the PropertyName property.

C#
public static readonly BindableProperty PropertyNameProperty

PropertyValueProperty

BindableProperty

Identifies the PropertyValue property.

C#
public static readonly BindableProperty PropertyValueProperty

RowSpacingProperty

BindableProperty

Identifies the RowSpacing property.

C#
public static readonly BindableProperty RowSpacingProperty

ValidationModeProperty

BindableProperty

Identifies the ValidationMode property.

C#
public static readonly BindableProperty ValidationModeProperty

Properties

ActualEditorStyle

Style

Gets the result from merging the Style specified in the EditorStyle property and the default base Style for that property.

C#
public Style ActualEditorStyle { get; }

ActualErrorDisplayOptions

Gets the actual value specified with the ErrorDisplayOptions property or inherided from the ErrorDisplayOptions property of the RadDataForm.

C#
public DataFormErrorDisplayOptions ActualErrorDisplayOptions { get; }

ActualErrorImageSource

ImageSource

Gets the actual value specified with the ErrorImageSource property or inherided from the ErrorImageSource property of the RadDataForm.

C#
public ImageSource ActualErrorImageSource { get; }

ActualErrorImageStyle

Style

Gets the result from merging the Style specified in the ErrorImageStyle property and the default base Style for that property.

C#
public Style ActualErrorImageStyle { get; }

ActualErrorLabelStyle

Style

Gets the result from merging the Style specified in the ErrorLabelStyle property and the default base Style for that property.

C#
public Style ActualErrorLabelStyle { get; }

ActualErrorLength

GridLength

Gets the actual value specified with the ErrorLength property or inherided from the ErrorLength property of the RadDataForm.

C#
[TypeConverter(typeof(GridLengthTypeConverter))]
public GridLength ActualErrorLength { get; }

ActualErrorPosition

Gets the actual value specified with the ErrorPosition property or inherided from the ErrorPosition property of the RadDataForm.

C#
public DataFormErrorPosition ActualErrorPosition { get; }

ActualHeaderDisplayOptions

Gets the actual value specified with the HeaderDisplayOptions property or inherided from the HeaderDisplayOptions property of the RadDataForm.

C#
public DataFormHeaderDisplayOptions ActualHeaderDisplayOptions { get; }

ActualHeaderImageSource

ImageSource

Gets the actual value specified with the HeaderImageSource property or inherided from the HeaderImageSource property of the RadDataForm.

C#
public ImageSource ActualHeaderImageSource { get; }

ActualHeaderImageStyle

Style

Gets the result from merging the Style specified in the HeaderImageStyle property and the default base Style for that property.

C#
public Style ActualHeaderImageStyle { get; }

ActualHeaderLabelStyle

Style

Gets the result from merging the Style specified in the HeaderLabelStyle property and the default base Style for that property.

C#
public Style ActualHeaderLabelStyle { get; }

ActualHeaderLength

GridLength

Gets the actual value specified with the HeaderLength property or inherided from the HeaderLength property of the RadDataForm.

C#
[TypeConverter(typeof(GridLengthTypeConverter))]
public GridLength ActualHeaderLength { get; }

ActualHeaderPosition

Gets the actual value specified with the HeaderPosition property or inherided from the HeaderPosition property of the RadDataForm.

C#
public DataFormHeaderPosition ActualHeaderPosition { get; }

ColumnSpacing

Gets or sets the horizontal spacing between the columns in the DataFormEditor.

C#
public double ColumnSpacing { get; set; }

CommitMode

Gets or sets the current commit mode of the DataFormEditor. For more information see the DataFormCommitMode type.

C#
public DataFormCommitMode CommitMode { get; set; }

Converter

IValueConverter

Gets or sets a IValueConverter to use when performing conversions between the value from the business object and the current editor.

C#
public IValueConverter Converter { get; set; }

ConverterParameter

Gets or sets a custom parameter to pass to the IValueConverter when performing conversions between the value from the business object and the current editor.

C#
public object ConverterParameter { get; set; }

EditorStyle

Style

Gets or sets the Style applied to the editor control. The target type of this Style depends on the actual editor control being used. For more information see the descendants of the DataFormEditor class.

C#
public Style EditorStyle { get; set; }

EditorValue

Gets or sets the current edited value, before applying it to the business object.

C#
public object EditorValue { get; set; }

ErrorDisplayOptions

Gets or sets display options of the error indicator in the DataFormEditor. For more information see the DataFormErrorDisplayOptions type.

C#
public DataFormErrorDisplayOptions? ErrorDisplayOptions { get; set; }

ErrorImageSource

ImageSource

Gets or sets the ImageSource of the error icon.

C#
public ImageSource ErrorImageSource { get; set; }

ErrorImageStyle

Style

Gets or sets the Style applied to the error icon. The target type of this Style is .

C#
public Style ErrorImageStyle { get; set; }

ErrorLabelStyle

Style

Gets or sets the Style applied to the error label. The target type of this Style is .

C#
public Style ErrorLabelStyle { get; set; }

ErrorLength

GridLength

Gets or sets the length of the error indicator in the editor. This property has an effect only when the ErrorPosition property is set to Beside. You can specify absolute values in pixels or weighted values followed by the asterisk symbol "". For instance, the value of "0.1" specifies that the error length should be 10% from the length of the corresponding editor. The special value "Auto" specifies that the error length should be computed automatically for each error indicator, based on the actual error size requirements.

C#
[TypeConverter(typeof(GridLengthTypeConverter))]
public GridLength ErrorLength { get; set; }

ErrorPosition

Gets or sets a value specifying the relative position of the error indicator in the DataFormEditor. For more information see the DataFormErrorPosition type.

C#
public DataFormErrorPosition? ErrorPosition { get; set; }

HasPendingChanges

Gets a value indicating whether there are pending changes.

C#
public bool HasPendingChanges { get; }

HasValidationErrors

Gets a value indicating whether there are validation errors.

C#
public bool HasValidationErrors { get; }

HeaderDisplayOptions

Gets or sets the display options of the header in the DataFormEditor. For more information see the DataFormHeaderDisplayOptions type.

C#
public DataFormHeaderDisplayOptions? HeaderDisplayOptions { get; set; }

HeaderImageSource

ImageSource

Gets or sets the ImageSource of the header icon.

C#
public ImageSource HeaderImageSource { get; set; }

HeaderImageStyle

Style

Gets or sets the Style applied to the header icon. The target type of this Style is .

C#
public Style HeaderImageStyle { get; set; }

HeaderLabelStyle

Style

Gets or sets the Style applied to the header label in the DataFormEditor. The target type of this Style is .

C#
public Style HeaderLabelStyle { get; set; }

HeaderLength

GridLength

Gets or sets the length of the header view in the editor. This property has an effect only when the HeaderPosition property is set to Beside. You can specify absolute values in pixels or weighted values followed by the asterisk symbol "". For instance, the value of "0.5" specifies that the header length should be 50% from the length of the corresponding editor. The special value "Auto" specifies that the header length should be computed automatically for the header view, based on the actual header size requirements.

C#
[TypeConverter(typeof(GridLengthTypeConverter))]
public GridLength HeaderLength { get; set; }

HeaderPosition

Gets or sets a value specifying the relative position of the header label in the DataFormEditor. For more information see the DataFormHeaderPosition type.

C#
public DataFormHeaderPosition? HeaderPosition { get; set; }

HeaderText

Gets or sets the text of the header label in the DataFormEditor.

C#
public string HeaderText { get; set; }

IsErrorImageVisible

Gets a value indicating whether the error icon is currently visible in the DataFormEditor.

C#
public bool IsErrorImageVisible { get; }

IsErrorLabelVisible

Gets a value indicating whether the error label is currently visible in the DataFormEditor.

C#
public bool IsErrorLabelVisible { get; }

IsHeaderImageVisible

Gets a value indicating whether the header icon is currently visible in the DataFormEditor.

C#
public bool IsHeaderImageVisible { get; }

IsHeaderLabelVisible

Gets a value indicating whether the header label is currently visible in the DataFormEditor.

C#
public bool IsHeaderLabelVisible { get; }

IsReadOnly

Gets or sets a value indicating whether the current editor is in a read-only mode.

C#
public bool? IsReadOnly { get; set; }

PropertyName

Gets or sets the name of the property from the business object this editor is bound to.

C#
public string PropertyName { get; set; }

PropertyValue

Gets or sets the value of the property from the business object this editor is bound to.

C#
public object PropertyValue { get; set; }

RowSpacing

Gets or sets the vertical spacing between the rows in the DataFormEditor.

C#
public double RowSpacing { get; set; }

ValidationErrors

Gets a collection of validation errors that are produced after the last execution of the validation logic associated with the current DataFormEditor. This collection aggregates all validation errors produced by the validation rules from the property metadata of the underlying business object data model and all custom validation rules specified to the editor. For more information see the DataFormEditorValidationError type.

C#
public IReadOnlyList<DataFormEditorValidationError> ValidationErrors { get; }

ValidationMode

Gets or sets the current validation mode of the DataFormEditor. For more information see the DataFormValidationMode type.

C#
public DataFormValidationMode ValidationMode { get; set; }

ValidationRules

Gets a collection of validation rules associated with the current DataFormEditor. The validation rules specified here extend the base set of validation rules that come from the metadata of the underlying business object data model. When the validation logic is triggered, these validation rules are executed last, after executing the validation rules for the corresponding property. This makes it possible to execute more advanced validation logic beside what is specified with metadata and provide more detailed validation errors. For more information see the inheritors of the DataFormEditorValidationRule type.

C#
public IList<DataFormEditorValidationRule> ValidationRules { get; }

Methods

CancelChanges()

Cancels all pending changes in the DataFormEditor and reverts to the original property value from the underlying business object. This method is mostly useful when the CommitMode property is set to Explicit.

C#
public void CancelChanges()

CommitChanges()

Commits all pending changes in the DataFormEditor to the corresponding property of the underlying business object. This method is mostly useful when the CommitMode property is set to Explicit.

C#
public bool CommitChanges()
Returns:

bool

True if the validation passes and the changes are committed successfully, false otherwise.

ValidateChanges()

Executes the validation logic associated with the current DataFormEditor. This method is mostly useful when the ValidationMode property is set to Explicit.

C#
public bool ValidateChanges()
Returns:

bool

True if the validation passes, false otherwise.

Events

ValidationCompleted

Raised when the validation of the editor has completed.

C#
public event EventHandler<DataFormEditorValidationCompletedEventArgs> ValidationCompleted

ValueChanged

Raised when the value of the editor has changed.

C#
public event EventHandler<DataFormEditorValueChangedEventArgs> ValueChanged
In this article
DefinitionConstructorsDataFormEditor()FieldsActualEditorStylePropertyActualErrorDisplayOptionsPropertyActualErrorImageSourcePropertyActualErrorImageStylePropertyActualErrorLabelStylePropertyActualErrorLengthPropertyActualErrorPositionPropertyActualHeaderDisplayOptionsPropertyActualHeaderImageSourcePropertyActualHeaderImageStylePropertyActualHeaderLabelStylePropertyActualHeaderLengthPropertyActualHeaderPositionPropertyColumnSpacingPropertyCommitModePropertyConverterParameterPropertyConverterPropertyEditorStylePropertyEditorValuePropertyErrorDisplayOptionsPropertyErrorImageSourcePropertyErrorImageStylePropertyErrorLabelStylePropertyErrorLengthPropertyErrorPositionPropertyHasPendingChangesPropertyHasValidationErrorsPropertyHeaderDisplayOptionsPropertyHeaderImageSourcePropertyHeaderImageStylePropertyHeaderLabelStylePropertyHeaderLengthPropertyHeaderPositionPropertyHeaderTextPropertyIsErrorImageVisiblePropertyIsErrorLabelVisiblePropertyIsHeaderImageVisiblePropertyIsHeaderLabelVisiblePropertyIsReadOnlyPropertyPropertyNamePropertyPropertyValuePropertyRowSpacingPropertyValidationModePropertyPropertiesActualEditorStyleActualErrorDisplayOptionsActualErrorImageSourceActualErrorImageStyleActualErrorLabelStyleActualErrorLengthActualErrorPositionActualHeaderDisplayOptionsActualHeaderImageSourceActualHeaderImageStyleActualHeaderLabelStyleActualHeaderLengthActualHeaderPositionColumnSpacingCommitModeConverterConverterParameterEditorStyleEditorValueErrorDisplayOptionsErrorImageSourceErrorImageStyleErrorLabelStyleErrorLengthErrorPositionHasPendingChangesHasValidationErrorsHeaderDisplayOptionsHeaderImageSourceHeaderImageStyleHeaderLabelStyleHeaderLengthHeaderPositionHeaderTextIsErrorImageVisibleIsErrorLabelVisibleIsHeaderImageVisibleIsHeaderLabelVisibleIsReadOnlyPropertyNamePropertyValueRowSpacingValidationErrorsValidationModeValidationRulesMethodsCancelChanges()CommitChanges()ValidateChanges()EventsValidationCompletedValueChanged
Not finding the help you need?
Contact Support