RuleCriteriaAttribute(String, DefaultContexts, String) Constructor

Initializes a new instance of the RuleCriteriaAttribute class.

Namespace: DevExpress.Persistent.Validation

Assembly: DevExpress.Persistent.Base.v24.1.dll

NuGet Package: DevExpress.Persistent.Base

Declaration

C#

public RuleCriteriaAttribute(
    string id,
    DefaultContexts targetContexts,
    string criteria
)

VB.NET

Public Sub New(
    id As String,
    targetContexts As DefaultContexts,
    criteria As String
)

Parameters

Name	Type	Description
id	String	A string value representing the current rule identifier. You can pass an empty value as the id parameter. An appropriate identifier will be generated automatically, and set for the ID property of the Validation | Rules | Rule node in the Application Model.
targetContexts	DefaultContexts	A DefaultContexts enumeration value that specifies a context for checking the current rule. This value is set for the RuleBaseAttribute.TargetContextIDs property.
criteria	String	A string value representing a criteria that must be satisfied by target class’ objects. To learn how to set a criteria, refer to the Ways to Build Criteria topic.

Remarks

If you are going to set a custom message template instead of a default one, use a constructor with the messageTemplate parameter.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RuleCriteriaAttribute(String, DefaultContexts, String) constructor.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

xaf-how-to-use-data-from-security-in-criterion/CS/CustomFunctionCriteriaOperator.Module/BusinessObjects/ValidatedObject.cs#L14

[DefaultClassOptions]
[RuleCriteria("", DefaultContexts.Save, "Company.Oid = CurrentCompanyOid()")]
public class ValidatedObject : BaseObject {

xaf-how-to-implement-a-singleton-class/CS/HowToImplementSingleton.Module/Singleton.cs#L12

CustomMessageTemplate = "Another Singleton already exists.")]
[RuleCriteria("CannotDeleteSingleton", DefaultContexts.Delete, "False",
CustomMessageTemplate = "Cannot delete Singleton.")]

XAF_how-to-set-validation-rules-in-code-e249/CS/HowToSetValidationRulesInCode.Module/Incident.cs#L14

[DefaultProperty("Subject")]
[RuleCriteria("RuleCriteria for Incident", DefaultContexts.Save,  "AssignedTo is not null", SkipNullOrEmptyValues = false)]
public class Incident : BaseObject {

VB.NET

xaf-how-to-use-data-from-security-in-criterion/VB/CustomFunctionCriteriaOperator.Module/BusinessObjects/ValidatedObject.vb#L13

Namespace CustomFunctionCriteriaOperator.Module.BusinessObjects
   <DefaultClassOptions, RuleCriteria("", DefaultContexts.Save, "Company.Oid = CurrentCompanyOid()")> _
   Public Class ValidatedObject

xaf-how-to-implement-a-singleton-class/VB/HowToImplementSingleton.Module/Singleton.vb#L10

Namespace HowToImplementSingleton.Module
    <RuleObjectExists("AnotherSingletonExists", DefaultContexts.Save, "True", InvertResult := True, CustomMessageTemplate := "Another Singleton already exists."), RuleCriteria("CannotDeleteSingleton", DefaultContexts.Delete, "False", CustomMessageTemplate := "Cannot delete Singleton.")> _
    Public Class Singleton

XAF_how-to-set-validation-rules-in-code-e249/VB/HowToSetValidationRulesInCode.Module/Incident.vb#L10

Namespace HowToSetValidationRulesInCode.Module
    <DefaultClassOptions, DefaultProperty("Subject"), RuleCriteria("RuleCriteria for Incident", DefaultContexts.Save, "AssignedTo is not null", SkipNullOrEmptyValues := False)>
    Public Class Incident