ClassRadDataEntryElement
Represents the main element in the RadDataEntry control hierarchy tree that encapsulates the actual data entry functionality. This element is responsible for automatically generating input controls based on data source properties and managing their layout and validation.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadDataEntryElement : RadScrollablePanelElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNodeInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemRadScrollablePanelElementRadDataEntryElement
Implements:
Inherited Members
Constructors
RadDataEntryElement()
Declaration
public RadDataEntryElement()Fields
ErrorIconProperty
The error icon property that specifies the icon displayed for validation errors.
Properties
AutoSizeLabels
Gets or sets a value indicating whether labels of the editors should be automatically sized to align properly in columns according to the longest text.
Declaration
public bool AutoSizeLabels { get; set; }Property Value
true if labels should be auto-sized for alignment; otherwise, false.
ColumnCount
Gets or sets the number of columns that RadDataEntry will use to arrange generated controls.
Declaration
public int ColumnCount { get; set; }Property Value
The number of columns. Must be at least 1.
Exceptions
Thrown when the value is less than 1.
CurrentObject
Gets the current object from the data source at the current position.
Declaration
public object CurrentObject { get; }Property Value
The current object, or null if no object is available at the current position.
DataSource
Gets or sets the data source for the RadDataEntry control.
Declaration
public object DataSource { get; set; }Property Value
The data source object. Setting to null will clear all generated editors.
ErrorIcon
Gets or sets the icon used by the error provider for displaying validation errors.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image ErrorIcon { get; set; }Property Value
The error icon image.
FitToParentWidth
Gets or sets a value indicating whether the generated editors should automatically fit their width to the width of the RadDataEntry.
Declaration
public bool FitToParentWidth { get; set; }Property Value
true if editors should fit to parent width; otherwise, false to use ItemDefaultSize.
FlowDirection
Gets or sets the flow direction for generating editors when the ColumnCount property is greater than 1.
Declaration
public FlowDirection FlowDirection { get; set; }Property Value
The flow direction that determines how controls are arranged across columns.
ItemDefaultSize
Gets or sets the default size that generated items should have when FitToParentWidth is false. When FitToParentWidth is true, the width is calculated based on the RadDataEntry width.
Declaration
public Size ItemDefaultSize { get; set; }Property Value
The default size of generated editor items, automatically scaled based on DPI settings.
ItemSpace
Gets or sets the spacing between the generated editor items.
Declaration
public int ItemSpace { get; set; }Property Value
The item space in pixels, automatically scaled based on DPI settings.
Manager
Gets the binding manager that manages the data binding for the current data source.
Declaration
public BindingManagerBase Manager { get; }Property Value
The BindingManagerBase instance associated with the data source.
Methods
ArrangeControls()
Arranges the generated controls in the specified column and row layout based on the current flow direction and column count.
Declaration
protected virtual void ArrangeControls()ArrangeLabels()
Arranges the labels in each column by calculating the maximum width needed and applying consistent sizing for proper alignment.
Declaration
protected virtual void ArrangeLabels()Bind()
Binds the data entry to the current data source by clearing existing controls and generating new editors based on the data source properties.
Declaration
public void Bind()Clear()
Clears all generated controls and resets the internal collections and validation information.
Declaration
public void Clear()CreateBinding(Control, string, string)
Creates a data binding between the specified control property and the data source member.
Declaration
protected virtual Binding CreateBinding(Control control, string propertyName, string dataMember)Parameters
control
The control to bind.
propertyName
The name of the control property to bind.
dataMember
The name of the data source member to bind to.
Returns
A Binding object, or null if binding creation was cancelled.
CreateBoolean(PropertyDescriptor)
Creates a RadCheckBox editor for boolean properties.
Declaration
protected virtual Control CreateBoolean(PropertyDescriptor property)Parameters
property
The property descriptor for the boolean property.
Returns
A configured RadCheckBox control or null if creation was cancelled.
CreateChildElements()
Creates and initializes the child elements of the RadDataEntryElement with appropriate CSS classes.
Declaration
protected override void CreateChildElements()Overrides
CreateColor(PropertyDescriptor)
Creates a RadColorBox editor for color properties.
Declaration
protected virtual Control CreateColor(PropertyDescriptor property)Parameters
property
The property descriptor for the color property.
Returns
A configured RadColorBox control or null if creation was cancelled.
CreateDateTime(PropertyDescriptor)
Creates a RadDateTimePicker editor for DateTime properties.
Declaration
protected virtual Control CreateDateTime(PropertyDescriptor property)Parameters
property
The property descriptor for the DateTime property.
Returns
A configured RadDateTimePicker control or null if creation was cancelled.
CreateEditors()
Creates appropriate editor controls for each browsable property in the data source.
Declaration
protected virtual void CreateEditors()CreateEnum(PropertyDescriptor)
Creates a RadDropDownList editor for enum properties.
Declaration
protected virtual Control CreateEnum(PropertyDescriptor property)Parameters
property
The property descriptor for the enum property.
Returns
A configured RadDropDownList control or null if creation was cancelled.
CreateImage(PropertyDescriptor)
Creates a PictureBox editor for image properties.
Declaration
protected virtual Control CreateImage(PropertyDescriptor property)Parameters
property
The property descriptor for the image property.
Returns
A configured PictureBox control or null if creation was cancelled.
CreateSpinEditor(PropertyDescriptor)
Creates a RadSpinEditor for numeric properties.
Declaration
protected virtual Control CreateSpinEditor(PropertyDescriptor property)Parameters
property
The property descriptor for the numeric property.
Returns
A configured RadSpinEditor control or null if creation was cancelled.
CreateTextBox(PropertyDescriptor)
Creates a RadTextBox editor for text properties.
Declaration
protected virtual Control CreateTextBox(PropertyDescriptor property)Parameters
property
The property descriptor for the text property.
Returns
A configured RadTextBox control or null if creation was cancelled.
FindRequiredProperties()
Analyzes the data source properties and identifies which properties should have editor controls created for them.
Declaration
protected virtual void FindRequiredProperties()GenerateControlsDesignTime(int, KeyValuePair<string, Control>, Size, Point)
Generates and arranges the editor controls at design time using the designer host services.
Declaration
protected virtual void GenerateControlsDesignTime(int currentColumn, KeyValuePair<string, Control> pair, Size propertyItemControlSize, Point propertyItemControlLocation)Parameters
currentColumn
The current column index for positioning.
pair
The key-value pair containing the property name and its associated editor control.
propertyItemControlSize
The size for the property item control.
propertyItemControlLocation
The location for the property item control.
GenerateControlsRunTime(int, KeyValuePair<string, Control>, Size, Point)
Generates and arranges the editor controls at runtime with proper theming and layout.
Declaration
protected virtual bool GenerateControlsRunTime(int currentColumn, KeyValuePair<string, Control> pair, Size propertyItemControlSize, Point propertyItemControlLocation)Parameters
currentColumn
The current column index for positioning.
pair
The key-value pair containing the property name and its associated editor control.
propertyItemControlSize
The size for the property item control.
propertyItemControlLocation
The location for the property item control.
Returns
true if the control was successfully generated; otherwise, false.
InitializeDataEntry()
Initializes the data entry by setting up designer services if available in design-time mode.
Declaration
protected virtual void InitializeDataEntry()InitializeFields()
Initializes the default field values for the RadDataEntryElement.
Declaration
protected override void InitializeFields()Overrides
OnBindingContextChanged(EventArgs)
Handles binding context changes and rebinds the data entry if necessary.
OnBindingCreated(object, BindingCreatedEventArgs)
Raises the BindingCreated event.
Declaration
protected virtual void OnBindingCreated(object sender, BindingCreatedEventArgs e)Parameters
sender
The sender of the event.
e
The BindingCreatedEventArgs instance containing the event data.
OnBindingCreating(object, BindingCreatingEventArgs)
Raises the BindingCreating event.
Declaration
protected virtual void OnBindingCreating(object sender, BindingCreatingEventArgs e)Parameters
sender
The sender of the event.
e
The BindingCreatingEventArgs instance containing the event data.
OnEditorInitialized(object, EditorInitializedEventArgs)
Raises the EditorInitialized event.
Declaration
protected virtual void OnEditorInitialized(object sender, EditorInitializedEventArgs e)Parameters
sender
The sender of the event.
e
The EditorInitializedEventArgs instance containing the event data.
OnEditorInitializing(object, EditorInitializingEventArgs)
Raises the EditorInitializing event.
Declaration
protected virtual void OnEditorInitializing(object sender, EditorInitializingEventArgs e)Parameters
sender
The sender of the event.
e
The EditorInitializingEventArgs instance containing the event data.
OnItemInitialized(object, ItemInitializedEventArgs)
Raises the ItemInitialized event.
Declaration
protected virtual void OnItemInitialized(object sender, ItemInitializedEventArgs e)Parameters
sender
The sender of the event.
e
The ItemInitializedEventArgs instance containing the event data.
OnItemInitializing(object, ItemInitializingEventArgs)
Raises the ItemInitializing event.
Declaration
protected virtual void OnItemInitializing(object sender, ItemInitializingEventArgs e)Parameters
sender
The sender of the event.
e
The ItemInitializingEventArgs instance containing the event data.
OnItemValidated(object, ItemValidatedEventArgs)
Raises the ItemValidated event.
Declaration
protected virtual void OnItemValidated(object sender, ItemValidatedEventArgs e)Parameters
sender
The sender of the event.
e
The ItemValidatedEventArgs instance containing the event data.
OnItemValidating(object, ItemValidatingEventArgs)
Raises the ItemValidating event.
Declaration
protected virtual void OnItemValidating(object sender, ItemValidatingEventArgs e)Parameters
sender
The sender of the event.
e
The ItemValidatingEventArgs instance containing the event data.
OnLoaded()
Called when the element is loaded and performs final setup including clearing control borders.
Declaration
protected override void OnLoaded()Overrides
SetupInnerControls(KeyValuePair<string, Control>, Size, Point, RadPanel, RadLabel, RadLabel, Control)
Configures the internal structure and properties of the container panel, label, validation label, and editor control.
Declaration
protected virtual void SetupInnerControls(KeyValuePair<string, Control> pair, Size propertyItemControlSize, Point propertyItemControlLocation, RadPanel propertyItemContainer, RadLabel labelControl, RadLabel validationControl, Control editorControl)Parameters
pair
The key-value pair containing the property name and its associated editor control.
propertyItemControlSize
The size for the property item control.
propertyItemControlLocation
The location for the property item control.
propertyItemContainer
The container panel that will hold all the controls.
labelControl
The label control displaying the property name.
validationControl
The label control for displaying validation messages.
editorControl
The editor control for the property value.
SubscribeControl(Control, PropertyDescriptor, RadLabel, RadLabel)
Subscribes a control to validation events and sets up error provider for the specified property.
Declaration
public void SubscribeControl(Control control, PropertyDescriptor property, RadLabel label, RadLabel validationLabel)Parameters
control
The editor control to subscribe.
property
The property descriptor associated with the control.
label
The label control displaying the property name.
validationLabel
The label control for displaying validation messages.
Events
BindingCreated
Occurs when a data binding has been successfully created for an editor control.
Declaration
public event BindingCreatedEventHandler BindingCreatedEvent Value
BindingCreating
Occurs when a data binding is being created for an editor control. This event can be cancelled to prevent binding creation.
Declaration
public event BindingCreatingEventHandler BindingCreatingEvent Value
EditorInitialized
Occurs when an editor control has been successfully initialized.
Declaration
public event EditorInitializedEventHandler EditorInitializedEvent Value
EditorInitializing
Occurs when an editor control is being initialized. This event can be cancelled to prevent editor creation.
Declaration
public event EditorInitializingEventHandler EditorInitializingEvent Value
ItemInitialized
Occurs when a property item container has been successfully initialized.
Declaration
public event ItemInitializedEventHandler ItemInitializedEvent Value
ItemInitializing
Occurs when a property item container is being initialized. This event can be cancelled to prevent item creation.
Declaration
public event ItemInitializingEventHandler ItemInitializingEvent Value
ItemValidated
Occurs when an editor item has been validated and validation has completed.
Declaration
public event ItemValidatedEventHandler ItemValidatedEvent Value
ItemValidating
Occurs when an editor item is being validated and validation rules are being checked.
Declaration
public event ItemValidatingEventHandler ItemValidatingEvent Value