ValidationModule.EnableRuntimeRuleCache Property

Specifies if the Validation Module caches Rules from custom persistent Rule Sources.

Namespace: DevExpress.ExpressApp.Validation

Assembly: DevExpress.ExpressApp.Validation.v23.2.dll

NuGet Package: DevExpress.ExpressApp.Validation

Declaration

C#

[DefaultValue(false)]
public bool EnableRuntimeRuleCache { get; set; }

VB.NET

<DefaultValue(False)>
Public Property EnableRuntimeRuleCache As Boolean

Property Value

Type	Default	Description
Boolean	false	true if the Validation Module caches Rules from custom persistent Rule Sources; otherwise, false.

Remarks

Built-in Rule Sources query the database each time before validation occurs. You can cache Rules to avoid unnecessary queries. The following code demonstrates how to enable Rule caching for all custom persistent Rule Sources in the platform-agnostic Module:

File: MySolution.Module\Module.cs(.vb).

C#

using DevExpress.ExpressApp.Validation;
// ...
public sealed partial class MySolutionModule : ModuleBase {
    //...
    public override void Setup(ApplicationModulesManager moduleManager) {
        base.Setup(moduleManager);
        //...
        ValidationModule _validationModule = moduleManager.Modules.FindModule<ValidationModule>();
        _validationModule.EnableRuntimeRuleCache = true;
    }
}

VB.NET

Imports DevExpress.ExpressApp.Validation
' ...
Partial Public NotInheritable Class MySolutionModule
    Inherits ModuleBase
    ' ...
    Public Overrides Sub Setup(ByVal moduleManager As ApplicationModulesManager)
        MyBase.Setup(moduleManager)
        ' ...
        Dim _validationModule As ValidationModule = moduleManager.Modules.FindModule(Of ValidationModule)()
        _validationModule.EnableRuntimeRuleCache = True
    End Sub
End Class

To enable or disable caching for a specific persistent Rule Source, subscribe to the CustomizeApplicationRuntimeRules event and specify the EnableRuleCache property:

C#

using DevExpress.ExpressApp.Validation;
// ...
public sealed partial class MySolutionModule : ModuleBase {
    //...
    public override void Setup(ApplicationModulesManager moduleManager) {
        base.Setup(moduleManager);
        //...
        ValidationModule _validationModule = moduleManager.Modules.FindModule<ValidationModule>();
        _validationModule.EnableRuntimeRuleCache = true;
        _validationModule.CustomizeApplicationRuntimeRules += ValidationModule_CustomizeApplicationRuntimeRules;
    }
    private void ValidationModule_CustomizeApplicationRuntimeRules(object sender, CustomizeApplicationRuntimeRulesEventArgs e) {
        foreach(var ruleSource in e.RuleSources) {
            PersistentContainerRuleSource containerRuleSource = ruleSource as PersistentContainerRuleSource;
            if(containerRuleSource != null) {
                if(typeof(MyPersistentRuleSource) == containerRuleSource.ClassType) {
                    containerRuleSource.EnableRuleCache = false;
                }
            }
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp.Validation
' ...
Partial Public NotInheritable Class MySolutionModule
    Inherits ModuleBase
    ' ...
    Public Overrides Sub Setup(ByVal moduleManager As ApplicationModulesManager)
        MyBase.Setup(moduleManager)
        ' ...
        Dim _validationModule As ValidationModule = moduleManager.Modules.FindModule(Of ValidationModule)()
        _validationModule.EnableRuntimeRuleCache = True
        AddHandler _validationModule.CustomizeApplicationRuntimeRules, AddressOf ValidationModule_CustomizeApplicationRuntimeRules
    End Sub
    Private Sub ValidationModule_CustomizeApplicationRuntimeRules(ByVal sender As Object, ByVal e As CustomizeApplicationRuntimeRulesEventArgs)
        For Each ruleSource As IRuleSource In e.RuleSources
            Dim containerRuleSource As PersistentContainerRuleSource = TryCast(ruleSource, PersistentContainerRuleSource)
            If containerRuleSource IsNot Nothing Then
                If GetType(MyPersistentRuleSource) Is containerRuleSource.ClassType Then
                    containerRuleSource.EnableRuleCache = False
                End If
            End If
        Next ruleSource
    End Sub
End Class

To clear the Rule cache for all persistent Rule Sources, use the RuleSet.DropCachedRules method. To clear the Rule cache for a specific persistent Rule Source, find a corresponding PersistentObjectRuleSource or PersistentContainerRuleSource instance in the Validator.RuleSet.RegisteredSources collection and call the DropCachedRules method.