ClassRadValidationProvider
Provides a validation management framework for RadEditorControl descendant editors, enabling the creation and enforcement of validation rules with visual error indicators and tooltips.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Editors")]
public class RadValidationProvider : Component, IComponent, IDisposable, ISupportInitialize, IExtenderProviderInheritance: objectMarshalByRefObjectComponentRadValidationProvider
Implements:
Inherited Members
Constructors
RadValidationProvider()
Initializes a new instance of the RadValidationProvider class.
Declaration
public RadValidationProvider()RadValidationProvider(IContainer)
Initializes a new instance of the RadValidationProvider class with the specified container control.
Declaration
public RadValidationProvider(IContainer container)Parameters
container
An object that implements the IContainer interface, and owns the created object.
Properties
AssociatedControls
Gets a collection of all RadEditorControl instances that have validation rules associated with them.
Declaration
[Browsable(false)]
public List<RadEditorControl> AssociatedControls { get; }Property Value
List<RadEditorControl>
ValidationMode
Gets or sets the validation mode that determines when validation should be triggered for associated controls.
Declaration
public ValidationMode ValidationMode { get; set; }Property Value
ValidationRules
Gets or sets the collection of validation rules that define the validation criteria for associated RadEditorControl instances.
Declaration
public FilterDescriptorCollection ValidationRules { get; set; }Property Value
Methods
BeginInit()
Signals the start of initialization for the validation provider component.
Declaration
public void BeginInit()Implements
CanExtend(object)
Indicates whether a control can be extended by this provider. Specifies whether this object can provide its extender properties to the specified object.
Declaration
public bool CanExtend(object extendee)Parameters
extendee
The object to be checked for extension capability.
Returns
true if the object can be extended (is a RadEditorControl); otherwise false.
Implements
ClearErrorStatus()
Clears the visual indication for validation errors on all associated controls.
Declaration
public virtual void ClearErrorStatus()ClearErrorStatus(RadControl)
Clears the visual indication for validation errors on the specified control.
Declaration
public virtual void ClearErrorStatus(RadControl associatedControl)Parameters
associatedControl
A RadControl descendant for which to clear the error status.
EndInit()
Signals the end of initialization for the validation provider component and ensures proper event subscription.
Declaration
public void EndInit()Implements
FireValidationEvent(bool, RadControl, IRadValidationRule)
Creates and fires a validation event with the specified parameters and returns the configured event arguments.
Declaration
protected virtual RadValidationEventArgs FireValidationEvent(bool isNotValid, RadControl associatedControl, IRadValidationRule rule)Parameters
isNotValid
true if validation has failed; otherwise false.
associatedControl
The RadControl being validated.
rule
The IRadValidationRule that was evaluated.
Returns
A configured RadValidationEventArgs object containing validation results and settings.
GetIconAlignment(RadEditorControl)
Gets the alignment of the error icon for the specified RadEditorControl.
Declaration
public ErrorIconAlignment GetIconAlignment(RadEditorControl control)Parameters
control
A target RadEditorControl for which to retrieve the icon alignment.
Returns
An ErrorIconAlignment value representing the current alignment setting for the control.
GetIconPadding(RadEditorControl)
Returns the amount of extra space to leave next to the error icon for the specified control.
Declaration
public Padding GetIconPadding(RadEditorControl control)Parameters
control
The RadEditorControl to get the padding for.
Returns
The padding to leave between the icon and the control.
GetValidationRule(RadEditorControl)
Returns the first validation rule associated with the specified RadEditorControl descendant.
Declaration
public FilterDescriptor GetValidationRule(RadEditorControl control)Parameters
control
A RadEditorControl descendant for which to retrieve the validation rule.
Returns
An IRadValidationRule that represents the validation rule associated with the editor, or null if no validation rule is associated with the specified control.
OnControlValidation(RadValidationEventArgs)
Raises the ControlValidation event with the specified validation event arguments.
Declaration
protected virtual void OnControlValidation(RadValidationEventArgs e)Parameters
e
A RadValidationEventArgs that contains the event data.
RemoveControlFromRules(RadEditorControl)
Removes a specific RadEditorControl from all validation rules in the provider.
Declaration
public void RemoveControlFromRules(RadEditorControl editorControl)Parameters
editorControl
A RadEditorControl descendant to remove from all validation rules.
RemoveRules(RadEditorControl)
Removes all validation rules associated with the specified RadEditorControl.
Declaration
public void RemoveRules(RadEditorControl control)Parameters
control
A RadEditorControl descendant for which to remove all associated rules.
RemoveValidationRule(RadEditorControl, IRadValidationRule)
Removes a specific validation rule association with the specified RadEditorControl descendant.
Declaration
public void RemoveValidationRule(RadEditorControl editorControl, IRadValidationRule ruleToRemove)Parameters
editorControl
A RadEditorControl descendant to remove from the rule.
ruleToRemove
The validation rule to disassociate from the control.
SetIconAlignment(RadEditorControl, ErrorIconAlignment)
Sets the alignment of the error icon for the specified RadEditorControl.
Declaration
public void SetIconAlignment(RadEditorControl control, ErrorIconAlignment errorIconAlignment)Parameters
control
A target RadEditorControl for which to set the icon alignment.
errorIconAlignment
An ErrorIconAlignment value that specifies the alignment to be set for the control.
SetIconPadding(RadEditorControl, Padding)
Sets the amount of extra space to leave between the specified control and the error icon.
Declaration
public void SetIconPadding(RadEditorControl control, Padding errorIconPadding)Parameters
control
The RadEditorControl to set the padding for.
errorIconPadding
The padding to add between the icon and the control.
SetValidationRule(RadEditorControl, FilterDescriptor)
Associates a validation rule with the specified RadEditorControl descendant.
Declaration
public void SetValidationRule(RadEditorControl control, FilterDescriptor rule)Parameters
control
A RadEditorControl descendant that represents the editor.
rule
An IRadValidationRule that represents the validation rule to associate.
ShowToolTip(RadControl, string, string, int, int, int, bool)
Shows a custom tooltip for validation errors with the specified parameters and styling.
Declaration
protected virtual void ShowToolTip(RadControl associatedControl, string toolTipText, string toolTipTitle, int toolTipX, int toolTipY, int toolTipDuration, bool enableToolTipShadow)Parameters
associatedControl
The RadControl to display the tooltip on.
toolTipText
The text content of the tooltip.
toolTipTitle
The title text of the tooltip.
toolTipX
The X coordinate position for the tooltip.
toolTipY
The Y coordinate position for the tooltip.
toolTipDuration
The duration in milliseconds to display the tooltip.
enableToolTipShadow
true to enable shadow effect on the tooltip; otherwise false.
Validate(RadEditorControl)
Validates the specified editor control against all associated validation rules.
Declaration
public bool Validate(RadEditorControl control)Parameters
control
A RadEditorControl or descendant that represents the editor to be validated.
Returns
true if the editor has been successfully validated against all rules; otherwise false.
Events
ControlValidation
Occurs before a RadEditorControl is being validated, allowing custom validation logic and error handling.
Declaration
public event RadValidationEventHandler ControlValidationEvent Value
ValidationModeChanged
Occurs when the ValidationMode property has changed, notifying subscribers of the validation timing change.
Declaration
public event EventHandler ValidationModeChangedEvent Value