Class

DataFormEditor

Initializes a new instance of the DataFormEditor class.

Declaration

public DataFormEditor()

Identifies the ActualEditorStyle property.

Declaration

public static readonly BindableProperty ActualEditorStyleProperty

Field Value

Identifies the ActualErrorDisplayOptions property.

Declaration

public static readonly BindableProperty ActualErrorDisplayOptionsProperty

Field Value

Identifies the ActualErrorImageSource property.

Declaration

public static readonly BindableProperty ActualErrorImageSourceProperty

Field Value

Identifies the ActualErrorImageStyle property.

Declaration

public static readonly BindableProperty ActualErrorImageStyleProperty

Field Value

Identifies the ActualErrorLabelStyle property.

Declaration

public static readonly BindableProperty ActualErrorLabelStyleProperty

Field Value

Identifies the ActualErrorLength property.

Declaration

public static readonly BindableProperty ActualErrorLengthProperty

Field Value

Identifies the ActualErrorPosition property.

Declaration

public static readonly BindableProperty ActualErrorPositionProperty

Field Value

Identifies the ActualHeaderDisplayOptions property.

Declaration

public static readonly BindableProperty ActualHeaderDisplayOptionsProperty

Field Value

Identifies the ActualHeaderImageSource property.

Declaration

public static readonly BindableProperty ActualHeaderImageSourceProperty

Field Value

Identifies the ActualHeaderImageStyle property.

Declaration

public static readonly BindableProperty ActualHeaderImageStyleProperty

Field Value

Identifies the ActualHeaderLabelStyle property.

Declaration

public static readonly BindableProperty ActualHeaderLabelStyleProperty

Field Value

Identifies the ActualHeaderLength property.

Declaration

public static readonly BindableProperty ActualHeaderLengthProperty

Field Value

Identifies the ActualHeaderPosition property.

Declaration

public static readonly BindableProperty ActualHeaderPositionProperty

Field Value

Identifies the ColumnSpacing property.

Declaration

public static readonly BindableProperty ColumnSpacingProperty

Field Value

Identifies the CommitMode property.

Declaration

public static readonly BindableProperty CommitModeProperty

Field Value

Identifies the ConverterParameter property.

Declaration

public static readonly BindableProperty ConverterParameterProperty

Field Value

Identifies the Converter property.

Declaration

public static readonly BindableProperty ConverterProperty

Field Value

Identifies the EditorStyle property.

Declaration

public static readonly BindableProperty EditorStyleProperty

Field Value

Identifies the EditorValue property.

Declaration

public static readonly BindableProperty EditorValueProperty

Field Value

Identifies the ErrorDisplayOptions property.

Declaration

public static readonly BindableProperty ErrorDisplayOptionsProperty

Field Value

Identifies the ErrorImageSource property.

Declaration

public static readonly BindableProperty ErrorImageSourceProperty

Field Value

Identifies the ErrorImageStyle property.

Declaration

public static readonly BindableProperty ErrorImageStyleProperty

Field Value

Identifies the ErrorLabelStyle property.

Declaration

public static readonly BindableProperty ErrorLabelStyleProperty

Field Value

Identifies the ErrorLength property.

Declaration

public static readonly BindableProperty ErrorLengthProperty

Field Value

Identifies the ErrorPosition property.

Declaration

public static readonly BindableProperty ErrorPositionProperty

Field Value

Identifies the HasPendingChanges property.

Declaration

public static readonly BindableProperty HasPendingChangesProperty

Field Value

Identifies the HasValidationErrors property.

Declaration

public static readonly BindableProperty HasValidationErrorsProperty

Field Value

Identifies the HeaderDisplayOptions property.

Declaration

public static readonly BindableProperty HeaderDisplayOptionsProperty

Field Value

Identifies the HeaderImageSource property.

Declaration

public static readonly BindableProperty HeaderImageSourceProperty

Field Value

Identifies the HeaderImageStyle property.

Declaration

public static readonly BindableProperty HeaderImageStyleProperty

Field Value

Identifies the HeaderLabelStyle property.

Declaration

public static readonly BindableProperty HeaderLabelStyleProperty

Field Value

Identifies the HeaderLength property.

Declaration

public static readonly BindableProperty HeaderLengthProperty

Field Value

Identifies the HeaderPosition property.

Declaration

public static readonly BindableProperty HeaderPositionProperty

Field Value

Identifies the HeaderText property.

Declaration

public static readonly BindableProperty HeaderTextProperty

Field Value

Identifies the IsErrorImageVisible property.

Declaration

public static readonly BindableProperty IsErrorImageVisibleProperty

Field Value

Identifies the IsErrorLabelVisible property.

Declaration

public static readonly BindableProperty IsErrorLabelVisibleProperty

Field Value

Identifies the IsHeaderImageVisible property.

Declaration

public static readonly BindableProperty IsHeaderImageVisibleProperty

Field Value

Identifies the IsHeaderLabelVisible property.

Declaration

public static readonly BindableProperty IsHeaderLabelVisibleProperty

Field Value

Identifies the IsReadOnly property.

Declaration

public static readonly BindableProperty IsReadOnlyProperty

Field Value

Identifies the PropertyName property.

Declaration

public static readonly BindableProperty PropertyNameProperty

Field Value

Identifies the PropertyValue property.

Declaration

public static readonly BindableProperty PropertyValueProperty

Field Value

Identifies the RowSpacing property.

Declaration

public static readonly BindableProperty RowSpacingProperty

Field Value

Identifies the ValidationMode property.

Declaration

public static readonly BindableProperty ValidationModeProperty

Field Value

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

Declaration

public Style ActualEditorStyle { get; }

Property Value

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

Declaration

public DataFormErrorDisplayOptions ActualErrorDisplayOptions { get; }

Property Value

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

Declaration

public ImageSource ActualErrorImageSource { get; }

Property Value

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

Declaration

public Style ActualErrorImageStyle { get; }

Property Value

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

Declaration

public Style ActualErrorLabelStyle { get; }

Property Value

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

Declaration

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

Property Value

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

Declaration

public DataFormErrorPosition ActualErrorPosition { get; }

Property Value

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

Declaration

public DataFormHeaderDisplayOptions ActualHeaderDisplayOptions { get; }

Property Value

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

Declaration

public ImageSource ActualHeaderImageSource { get; }

Property Value

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

Declaration

public Style ActualHeaderImageStyle { get; }

Property Value

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

Declaration

public Style ActualHeaderLabelStyle { get; }

Property Value

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

Declaration

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

Property Value

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

Declaration

public DataFormHeaderPosition ActualHeaderPosition { get; }

Property Value

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

Declaration

public double ColumnSpacing { get; set; }

Property Value

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

Declaration

public DataFormCommitMode CommitMode { get; set; }

Property Value

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

Declaration

public IValueConverter Converter { get; set; }

Property Value

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.

Declaration

public object ConverterParameter { get; set; }

Property Value

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.

Declaration

public Style EditorStyle { get; set; }

Property Value

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

Declaration

public object EditorValue { get; set; }

Property Value

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

Declaration

public DataFormErrorDisplayOptions? ErrorDisplayOptions { get; set; }

Property Value

Gets or sets the ImageSource of the error icon.

Declaration

public ImageSource ErrorImageSource { get; set; }

Property Value

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

Declaration

public Style ErrorImageStyle { get; set; }

Property Value

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

Declaration

public Style ErrorLabelStyle { get; set; }

Property Value

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

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

Property Value

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 DataFormErrorPosition? ErrorPosition { get; set; }

Property Value

Gets a value indicating whether there are pending changes.

Declaration

public bool HasPendingChanges { get; }

Property Value

Gets a value indicating whether there are validation errors.

Declaration

public bool HasValidationErrors { get; }

Property Value

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

Declaration

public DataFormHeaderDisplayOptions? HeaderDisplayOptions { get; set; }

Property Value

Gets or sets the ImageSource of the header icon.

Declaration

public ImageSource HeaderImageSource { get; set; }

Property Value

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

Declaration

public Style HeaderImageStyle { get; set; }

Property Value

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

Declaration

public Style HeaderLabelStyle { get; set; }

Property Value

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

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

Property Value

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 DataFormHeaderPosition? HeaderPosition { get; set; }

Property Value

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

Declaration

public string HeaderText { get; set; }

Property Value

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

Declaration

public bool IsErrorImageVisible { get; }

Property Value

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

Declaration

public bool IsErrorLabelVisible { get; }

Property Value

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

Declaration

public bool IsHeaderImageVisible { get; }

Property Value

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

Declaration

public bool IsHeaderLabelVisible { get; }

Property Value

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

Declaration

public bool? IsReadOnly { get; set; }

Property Value

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

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

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

Declaration

public double RowSpacing { get; set; }

Property Value

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

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

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

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()

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

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

Raised when the validation of the editor has completed.

Declaration

public event EventHandler<DataFormEditorValidationCompletedEventArgs> ValidationCompleted

Event Value

Raised when the value of the editor has changed.

Declaration

public event EventHandler<DataFormEditorValueChangedEventArgs> ValueChanged

Event Value