Class DataFormEditor

public abstract class DataFormEditor : DataFormItem, IRadContentView, IContentView, IPadding, ICrossPlatformLayout, IDataFormView, IView, IElement, ITransform

Constructors

DataFormEditor()

Initializes a new instance of the DataFormEditor class.

Declaration

public DataFormEditor()

Fields

ActualErrorDisplayOptionsProperty

Identifies the ActualErrorDisplayOptions property.

Declaration

public static readonly BindableProperty ActualErrorDisplayOptionsProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualErrorImageSourceProperty

Identifies the ActualErrorImageSource property.

Declaration

public static readonly BindableProperty ActualErrorImageSourceProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualHeaderDisplayOptionsProperty

Identifies the ActualHeaderDisplayOptions property.

Declaration

public static readonly BindableProperty ActualHeaderDisplayOptionsProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualHeaderImageSourceProperty

Identifies the ActualHeaderImageSource property.

Declaration

public static readonly BindableProperty ActualHeaderImageSourceProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualHeaderImageStyleProperty

Identifies the ActualHeaderImageStyle property.

Declaration

public static readonly BindableProperty ActualHeaderImageStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ActualHeaderLabelStyleProperty

Identifies the ActualHeaderLabelStyle property.

Declaration

public static readonly BindableProperty ActualHeaderLabelStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

Properties

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

Declaration

public Style EditorStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

EditorValue

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

Declaration

public object EditorValue { get; set; }

Property Value

System.Object

ErrorDisplayOptions

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

Declaration

public Nullable<DataFormErrorDisplayOptions> ErrorDisplayOptions { get; set; }

Property Value

System.Nullable<DataFormErrorDisplayOptions>

ErrorImageSource

Gets or sets the Microsoft.Maui.Controls.ImageSource of the error icon.

Declaration

public ImageSource ErrorImageSource { get; set; }

Property Value

Microsoft.Maui.Controls.ImageSource

ErrorImageStyle

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

Declaration

public Style ErrorImageStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

ErrorLabelStyle

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

Declaration

public Style ErrorLabelStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

ErrorLength

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.

Declaration

public GridLength ErrorLength { get; set; }

Property Value

Microsoft.Maui.GridLength

ErrorPosition

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

Declaration

public Nullable<DataFormErrorPosition> ErrorPosition { get; set; }

Property Value

System.Nullable<DataFormErrorPosition>

HasPendingChanges

Gets a value indicating whether there are pending changes.

Declaration

public bool HasPendingChanges { get; }

Property Value

System.Boolean

HasValidationErrors

Gets a value indicating whether there are validation errors.

Declaration

public bool HasValidationErrors { get; }

Property Value

System.Boolean

HeaderDisplayOptions

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

Declaration

public Nullable<DataFormHeaderDisplayOptions> HeaderDisplayOptions { get; set; }

Property Value

System.Nullable<DataFormHeaderDisplayOptions>

HeaderImageSource

Gets or sets the Microsoft.Maui.Controls.ImageSource of the header icon.

Declaration

public ImageSource HeaderImageSource { get; set; }

Property Value

Microsoft.Maui.Controls.ImageSource

HeaderImageStyle

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

Declaration

public Style HeaderImageStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

HeaderLabelStyle

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

Declaration

public Style HeaderLabelStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

HeaderLength

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.

Declaration

public GridLength HeaderLength { get; set; }

Property Value

Microsoft.Maui.GridLength

HeaderPosition

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

Declaration

public Nullable<DataFormHeaderPosition> HeaderPosition { get; set; }

Property Value

System.Nullable<DataFormHeaderPosition>

HeaderText

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

Declaration

public string HeaderText { get; set; }

Property Value

System.String

IsErrorImageVisible

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

Declaration

public bool IsErrorImageVisible { get; }

Property Value

System.Boolean

IsErrorLabelVisible

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

Declaration

public bool IsErrorLabelVisible { get; }

Property Value

System.Boolean

IsHeaderImageVisible

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

Declaration

public bool IsHeaderImageVisible { get; }

Property Value

System.Boolean

IsHeaderLabelVisible

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

Declaration

public bool IsHeaderLabelVisible { get; }

Property Value

System.Boolean

IsReadOnly

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

Declaration

public Nullable<bool> IsReadOnly { get; set; }

Property Value

System.Nullable<System.Boolean>

PropertyName

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

Declaration

public string PropertyName { get; set; }

Property Value

System.String

PropertyValue

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

Declaration

public object PropertyValue { get; set; }

Property Value

System.Object

RowSpacing

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

Declaration

public double RowSpacing { get; set; }

Property Value

System.Double

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.

Declaration

public IReadOnlyList<DataFormEditorValidationError> ValidationErrors { get; }

Property Value

System.Collections.Generic.IReadOnlyList<DataFormEditorValidationError>

ValidationMode

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

Declaration

public DataFormValidationMode ValidationMode { get; set; }

Property Value

DataFormValidationMode

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.

Declaration

public IList<DataFormEditorValidationRule> ValidationRules { get; }

Property Value

System.Collections.Generic.IList<DataFormEditorValidationRule>

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.

Declaration

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.

Declaration

public bool CommitChanges()

Returns

System.Boolean

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.

Declaration

public bool ValidateChanges()

Returns

System.Boolean

True if the validation passes, false otherwise.

Events

ValidationCompleted

Raised when the validation of the editor has completed.

Declaration

public event EventHandler<DataFormEditorValidationCompletedEventArgs> ValidationCompleted

Event Type

System.EventHandler<DataFormEditorValidationCompletedEventArgs>

ValueChanged

Raised when the value of the editor has changed.

Declaration

public event EventHandler<DataFormEditorValueChangedEventArgs> ValueChanged

Event Type

System.EventHandler<DataFormEditorValueChangedEventArgs>

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)