ValidationModule.CustomizeApplicationRuntimeRules Event

Occurs when the ValidationModule.InitializeRuleSet method is invoked.

Namespace: DevExpress.ExpressApp.Validation

Assembly: DevExpress.ExpressApp.Validation.v24.1.dll

NuGet Package: DevExpress.ExpressApp.Validation

Declaration

C#

public event EventHandler<CustomizeApplicationRuntimeRulesEventArgs> CustomizeApplicationRuntimeRules

VB.NET

Public Event CustomizeApplicationRuntimeRules As EventHandler(Of CustomizeApplicationRuntimeRulesEventArgs)

Event Data

The CustomizeApplicationRuntimeRules event's data class is CustomizeApplicationRuntimeRulesEventArgs. The following properties provide information specific to this event:

Property	Description
Application	Specifies the object providing methods and properties to manage the current application. Inherited from CustomizeRulesEventArgs.
ApplicationModelRuleSet	Specifies validation rules declared via the Application Model.
ObjectSpaceProvider	Specifies the Object Space Provider to be used to create Object Spaces for creation of additional validation rules.
Rules	Specifies additional validation rules to be used by the application. Inherited from CustomizeRulesEventArgs.
RuleSources	Specifies additional validation rule sources to be used by the application. Inherited from CustomizeRulesEventArgs.

Remarks

Handle this event to create validation rules at run time. Add the required rules to the Rules collection. The following code snippet demonstrates how to create a validation rule at run time, ensuring that an end-user will not be able to save a Contact object unless its Anniversary property is specified.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Validation;
using DevExpress.Persistent.Validation;
//...
public sealed partial class MyModule : ModuleBase {
    ValidationModule validationModule;
    public MyModule() {
        InitializeComponent();
    }
    public override void Setup(ApplicationModulesManager moduleManager) {
        base.Setup(moduleManager);
        validationModule = moduleManager.Modules.FindModule<ValidationModule>();
        validationModule.CustomizeApplicationRuntimeRules += OnCustomizeRules;
    }
    void OnCustomizeRules(object sender, CustomizeApplicationRuntimeRulesEventArgs e) {
        RuleRequiredField myRule =
            new RuleRequiredField("myRule", 
            XafTypesInfo.Instance.FindTypeInfo(typeof(Contact)).FindMember("Anniversary"), 
            ContextIdentifier.Save);
        e.Rules.Add(myRule);
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Validation
Imports DevExpress.Persistent.Validation
'...
Public NotInheritable Partial Class MyModule
    Inherits ModuleBase
    Private validationModule As ValidationModule
    Public Sub New()
        InitializeComponent()
    End Sub
    Public Overrides Sub Setup(ByVal moduleManager As ApplicationModulesManager)
        MyBase.Setup(moduleManager)
        validationModule = moduleManager.Modules.FindModule(Of ValidationModule)()
        AddHandler validationModule.CustomizeApplicationRuntimeRules, AddressOf OnCustomizeRules
    End Sub
    Private Sub OnCustomizeRules(ByVal sender As Object, _
    ByVal e As CustomizeApplicationRuntimeRulesEventArgs)
        Dim myRule As New RuleRequiredField("myRule", _
        XafTypesInfo.Instance.FindTypeInfo(GetType(Contact)).FindMember("Anniversary"), _
        ContextIdentifier.Save)
        e.Rules.Add(myRule)
    End Sub
End Class