CSLA.NET 5.4.2
CSLA .NET is a software development framework that helps you build a reusable, maintainable object-oriented business layer for your app.
Csla.Rules.CommonRules.InfoMessage Class Reference

Adds an information message to a property. More...

Inheritance diagram for Csla.Rules.CommonRules.InfoMessage:
Csla.Rules.BusinessRule Csla.Rules.BusinessRuleBase Csla.Rules.IBusinessRule Csla.Rules.IBusinessRuleBase Csla.Rules.IBusinessRuleBase

Public Member Functions

 InfoMessage (Csla.Core.IPropertyInfo primaryProperty)
 Creates an instance of the rule. More...
 
 InfoMessage (Csla.Core.IPropertyInfo primaryProperty, string messageText)
 Creates an instance of the rule. More...
 
 InfoMessage (Csla.Core.IPropertyInfo primaryProperty, Func< string > messageDelegate)
 Creates an instance of the rule. More...
 

Protected Member Functions

override void Execute (IRuleContext context)
 Rule implementation. More...
 
- Protected Member Functions inherited from Csla.Rules.BusinessRule
 BusinessRule ()
 Creates an instance of the rule that applies to a business object as a whole. More...
 
 BusinessRule (Csla.Core.IPropertyInfo primaryProperty)
 Creates an instance of the rule that applies to a specfic property. More...
 
- Protected Member Functions inherited from Csla.Rules.BusinessRuleBase
void CanWriteProperty (string argument)
 Allows or blocks changing a property value. More...
 
 BusinessRuleBase (Csla.Core.IPropertyInfo primaryProperty)
 Creates an instance of the rule that applies to a specfic property. More...
 
void LoadProperty (object obj, Csla.Core.IPropertyInfo propertyInfo, object newValue)
 Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change. More...
 
object ReadProperty (object obj, Csla.Core.IPropertyInfo propertyInfo)
 Reads a property's field value. More...
 

Properties

string MessageText [getprotected set]
 Gets the default description used by this rule. More...
 
Func< string > MessageDelegate [getset]
 Gets or sets the localizable message function. More...
 
- Properties inherited from Csla.Rules.BusinessRule
override bool IsAsync [getprotected set]
 Gets a value indicating whether the rule will run on a background thread. More...
 
- Properties inherited from Csla.Rules.BusinessRuleBase
bool PropertiesLocked [getset]
 Gets or sets a value indicating whether property values should be locked because an async operation is running. More...
 
virtual Csla.Core.IPropertyInfo PrimaryProperty [getset]
 Gets or sets the primary property affected by this rule. More...
 
List< Csla.Core.IPropertyInfoAffectedProperties [get]
 Gets a list of properties affected by this rule. More...
 
List< Csla.Core.IPropertyInfoInputProperties [getprotected set]
 Gets a list of secondary property values to be supplied to the rule when it is executed. More...
 
abstract bool IsAsync [getprotected set]
 Gets a value indicating whether the rule will run on a background thread. More...
 
bool ProvideTargetWhenAsync [getprotected 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). More...
 
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. More...
 
RuleUri RuleUri [getset]
 Sets or gets the rule:// URI object for this rule. More...
 
int Priority [getset]
 Gets the rule priority. More...
 
RunModes RunMode [getset]
 Gets or sets the run in context. More...
 
- Properties inherited from Csla.Rules.IBusinessRuleBase
List< Csla.Core.IPropertyInfoInputProperties [get]
 Gets a list of secondary property values to be supplied to the rule when it is executed. More...
 
List< Csla.Core.IPropertyInfoAffectedProperties [get]
 Gets a list of properties affected by this rule. More...
 
Csla.Core.IPropertyInfo PrimaryProperty [get]
 Gets the primary property affected by this rule. More...
 
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. More...
 
int Priority [get]
 Gets the rule priority. More...
 
bool ProvideTargetWhenAsync [get]
 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). More...
 
RunModes RunMode [get]
 Gets the context in which the rule is allowed to execute. More...
 
bool IsAsync [get]
 Gets a value indicating whether the Execute() method will run asynchronous code. More...
 

Detailed Description

Adds an information message to a property.

Message text is the DefaultDescription property. The default priority for this rule is 1, so if any rules are broken the infomational text won't appear.

Definition at line 620 of file Csla/Rules/CommonRules.cs.

Constructor & Destructor Documentation

◆ InfoMessage() [1/3]

Csla.Rules.CommonRules.InfoMessage.InfoMessage ( Csla.Core.IPropertyInfo  primaryProperty)

Creates an instance of the rule.

Parameters
primaryPropertyProperty for message.

Definition at line 650 of file Csla/Rules/CommonRules.cs.

◆ InfoMessage() [2/3]

Csla.Rules.CommonRules.InfoMessage.InfoMessage ( Csla.Core.IPropertyInfo  primaryProperty,
string  messageText 
)

Creates an instance of the rule.

Parameters
primaryPropertyProperty for message.
messageTextMessage text.

Definition at line 661 of file Csla/Rules/CommonRules.cs.

◆ InfoMessage() [3/3]

Csla.Rules.CommonRules.InfoMessage.InfoMessage ( Csla.Core.IPropertyInfo  primaryProperty,
Func< string >  messageDelegate 
)

Creates an instance of the rule.

Parameters
primaryPropertyProperty for message.
messageDelegateMessage text function.

Definition at line 672 of file Csla/Rules/CommonRules.cs.

Member Function Documentation

◆ Execute()

override void Csla.Rules.CommonRules.InfoMessage.Execute ( IRuleContext  context)
protectedvirtual

Rule implementation.

Parameters
contextRule context.

Reimplemented from Csla.Rules.BusinessRule.

Definition at line 682 of file Csla/Rules/CommonRules.cs.

Property Documentation

◆ MessageDelegate

Func<string> Csla.Rules.CommonRules.InfoMessage.MessageDelegate
getset

Gets or sets the localizable message function.

This will override the MessageText if set.

The localizable message.

Definition at line 640 of file Csla/Rules/CommonRules.cs.

◆ MessageText

string Csla.Rules.CommonRules.InfoMessage.MessageText
getprotected set

Gets the default description used by this rule.

Definition at line 625 of file Csla/Rules/CommonRules.cs.