Csla.Rules.PropertyRule Class Reference

Base class for a property rule. More...

Inheritance diagram for Csla.Rules.PropertyRule:

Protected Member Functions
virtual string	GetMessage ()
	Gets the error message text.
	PropertyRule ()
	Initializes a new instance of the PropertyRule class.
	PropertyRule (IPropertyInfo? propertyInfo)
	Initializes a new instance of the PropertyRule class.
Protected Member Functions inherited from Csla.Rules.BusinessRule
	BusinessRule ()
	Creates an instance of the rule that applies to a business object as a whole.
	BusinessRule (Core.IPropertyInfo? primaryProperty)
	Creates an instance of the rule that applies to a specfic property.
virtual void	Execute (IRuleContext context)
	Business or validation rule implementation.
Protected Member Functions inherited from Csla.Rules.BusinessRuleBase
void	CanWriteProperty (string argument)
	Allows or blocks changing a property value.
	BusinessRuleBase (IPropertyInfo? primaryProperty)
	Creates an instance of the rule that applies to a specfic property.
void	LoadProperty (object obj, IPropertyInfo propertyInfo, object? newValue)
	Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.
object?	ReadProperty (object obj, IPropertyInfo propertyInfo)
	Reads a property's field value.

Properties
string	MessageText [get, set]
	Gets or sets the error message (constant).
Func< string >?	MessageDelegate [get, set]
	Gets or sets the error message function for this rule. Use this for localizable messages from a resource file.
bool	HasMessageDelegate [get]
	Gets a value indicating whether this instance has message delegate.
bool	CanRunAsAffectedProperty [get, set]
	Gets or sets a value indicating whether this instance can run as affected property.
bool	CanRunOnServer [get, set]
	Gets or sets a value indicating whether this instance can run in logical serverside data portal.
bool	CanRunInCheckRules [get, set]
	Gets or sets a value indicating whether this instance can run when CheckRules is called on BO.
Properties inherited from Csla.Rules.BusinessRule
override bool	IsAsync [get, protected set]
	Gets a value indicating whether the rule will run on a background thread.
Properties inherited from Csla.Rules.BusinessRuleBase
bool	CascadeIfDirty [get, protected set]
	If true, rule will only cascade if the primary property is dirty.
bool	PropertiesLocked [get, set]
	Gets or sets a value indicating whether property values should be locked because an async operation is running.
virtual ? IPropertyInfo	PrimaryProperty [get, set]
	Gets or sets the primary property affected by this rule.
List< IPropertyInfo >	AffectedProperties [get]
	Gets a list of properties affected by this rule. Rules for these properties are executed after rules for the primary property.
List< IPropertyInfo >	InputProperties [get]
	Gets a list of secondary property values to be supplied to the rule when it is executed.
bool	IsAsync [get, protected set]
	Gets a value indicating whether the rule will run on a background thread.
bool	ProvideTargetWhenAsync [get, protected set]
	Gets a value indicating that the Target property should be set even for an async rule (note that using Target from a background thread will cause major problems).
string	RuleName [get]
	Gets a unique rule:// URI for the specific instance of the rule within the context of the business object where the rule is used.
RuleUri	RuleUri [get, set]
	Sets or gets the rule:// URI object for this rule.
int	Priority [get, set]
	Gets the rule priority.
RunModes	RunMode [get, set]
	Gets or sets the run in context.
int	DisplayIndex [get, set]
	Gets the rule DisplayIndex in UI.

Detailed Description

Base class for a property rule.

Constructor & Destructor Documentation

PropertyRule() [1/2]

Csla.Rules.PropertyRule.PropertyRule ( )

inlineprotected

Initializes a new instance of the PropertyRule class.

PropertyRule() [2/2]

Csla.Rules.PropertyRule.PropertyRule ( IPropertyInfo? propertyInfo )

inlineprotected

Initializes a new instance of the PropertyRule class.

Parameters

propertyInfo

The property info.

Member Function Documentation

GetMessage()

virtual string Csla.Rules.PropertyRule.GetMessage ( )

inlineprotectedvirtual

Gets the error message text.

Reimplemented in Csla.Rules.CommonRules.MaxLength, Csla.Rules.CommonRules.MaxValue< T >, Csla.Rules.CommonRules.MinLength, Csla.Rules.CommonRules.MinValue< T >, Csla.Rules.CommonRules.RegExMatch, and Csla.Rules.CommonRules.Required.

Property Documentation

CanRunAsAffectedProperty

bool Csla.Rules.PropertyRule.CanRunAsAffectedProperty

getset

Gets or sets a value indicating whether this instance can run as affected property.

true if this instance can run as affected property; otherwise, false.

CanRunInCheckRules

bool Csla.Rules.PropertyRule.CanRunInCheckRules

getset

Gets or sets a value indicating whether this instance can run when CheckRules is called on BO.

true if this instance can run when CheckRules is called; otherwise, false.

CanRunOnServer

bool Csla.Rules.PropertyRule.CanRunOnServer

getset

Gets or sets a value indicating whether this instance can run in logical serverside data portal.

true if this instance can run logical serverside data portal; otherwise, false.

HasMessageDelegate

bool Csla.Rules.PropertyRule.HasMessageDelegate

getprotected

Gets a value indicating whether this instance has message delegate.

true if this instance has message delegate; otherwise, false.

MessageDelegate

Func<string>? Csla.Rules.PropertyRule.MessageDelegate

getset

Gets or sets the error message function for this rule. Use this for localizable messages from a resource file.

MessageText

string Csla.Rules.PropertyRule.MessageText

getset

Gets or sets the error message (constant).

Exceptions

InvalidOperationException

MessageDelegate is null.

---

The documentation for this class was generated from the following file:

• csla/Source/Csla/Rules/PropertyRule.cs