Class ValidationContext

Namespace

The.Entities

Assembly

Instagile.dll

Contains information about all the validation rules applicable to a particular context (usually a page containing fields and commands), as well as which rules have been triggered already (depending on the triggers defined in their ValidationScope(s))

public class ValidationContext

Inheritance

object

ValidationContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

ValidationContext(IServices, IEntity?)

public ValidationContext(IServices services, IEntity? entity = null)

Parameters

services IServices

entity IEntity

Properties

Entity

public IEntity? Entity { get; }

Property Value

IEntity

Rules

public IDictionary<IValidatable, IList<IValidationRule>> Rules { get; }

Property Value

IDictionary<IValidatable, IList<IValidationRule>>

Services

public IServices Services { get; }

Property Value

IServices

TriggeredRules

public IDictionary<IValidationRule, ISet<ValidationScope.TriggerEnum>> TriggeredRules { get; }

Property Value

IDictionary<IValidationRule, ISet<ValidationScope.TriggerEnum>>

Methods

AddRule(IValidatable, IValidationRule)

public void AddRule(IValidatable field, IValidationRule rule)

Parameters

field IValidatable

rule IValidationRule

AddRules(IValidatable, IEnumerable<IValidationRule>)

public void AddRules(IValidatable field, IEnumerable<IValidationRule> rules)

Parameters

field IValidatable

rules IEnumerable<IValidationRule>

ClearAllTriggers()

Clears the triggered state on all rules

public bool ClearAllTriggers()

Returns

bool

True: at least one triggered state was cleared, False: no rules had triggered state to clear

CommandHasTriggered(string)

public bool CommandHasTriggered(string commandKey)

Parameters

commandKey string

Returns

bool

FieldChanged(IValidatable, bool)

public bool FieldChanged(IValidatable field, bool hasChanges)

Parameters

field IValidatable

hasChanges bool

Returns

bool

GetCurrentValidationResult()

public ValidationResultType GetCurrentValidationResult()

Returns

ValidationResultType

GetFieldsForRule(IValidationRule)

public IEnumerable<IValidatable> GetFieldsForRule(IValidationRule rule)

Parameters

rule IValidationRule

Returns

IEnumerable<IValidatable>

HasAsyncTriggeredRulesFor(IValidatable)

public bool HasAsyncTriggeredRulesFor(IValidatable field)

Parameters

field IValidatable

Returns

bool

HasTrigger(IValidatable, TriggerEnum)

public bool HasTrigger(IValidatable field, ValidationScope.TriggerEnum trigger)

Parameters

field IValidatable

trigger ValidationScope.TriggerEnum

Returns

bool

HasTriggeredRulesFor(IValidatable)

public bool HasTriggeredRulesFor(IValidatable field)

Parameters

field IValidatable

Returns

bool

IsTriggered(IValidationRule)

public bool IsTriggered(IValidationRule rule)

Parameters

rule IValidationRule

Returns

bool

NotifyValidationChanged(IValidatable)

public void NotifyValidationChanged(IValidatable field)

Parameters

field IValidatable

RemoveRule(IValidatable, IValidationRule)

public void RemoveRule(IValidatable field, IValidationRule rule)

Parameters

field IValidatable

rule IValidationRule

RemoveRules(IValidatable, IEnumerable<IValidationRule>)

public void RemoveRules(IValidatable field, IEnumerable<IValidationRule> rules)

Parameters

field IValidatable

rules IEnumerable<IValidationRule>

RulesFor(IValidatable)

public IValidationRule[] RulesFor(IValidatable field)

Parameters

field IValidatable

Returns

IValidationRule[]

RulesForCommand(string)

public IEnumerable<(IValidatable Field, IValidationRule Rule)> RulesForCommand(string commandKey)

Parameters

commandKey string

Returns

IEnumerable<(IValidatable Field, IValidationRule Rule)>

SetAllCommandsTriggered(bool)

public bool SetAllCommandsTriggered(bool triggered)

Parameters

triggered bool

Returns

bool

SetCommandTriggered(string, bool)

public bool SetCommandTriggered(string commandKey, bool triggered)

Parameters

commandKey string

triggered bool

Returns

bool

SetFieldLostFocusTriggered(IValidatable, bool)

public bool SetFieldLostFocusTriggered(IValidatable field, bool triggered)

Parameters

field IValidatable

triggered bool

Returns

bool

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

TriggeredRulesFor(IValidatable)

public IEnumerable<IValidationRule> TriggeredRulesFor(IValidatable field)

Parameters

field IValidatable

Returns

IEnumerable<IValidationRule>

ValidateField(IValidatable)

public ValidationResults ValidateField(IValidatable field)

Parameters

field IValidatable

Returns

ValidationResults

ValidateFieldAsync(IValidatable)

public Task<ValidationResults> ValidateFieldAsync(IValidatable field)

Parameters

field IValidatable

Returns

Task<ValidationResults>

ValidateForCommand(string)

public Task<ValidationResults> ValidateForCommand(string commandKey)

Parameters

commandKey string

Returns

Task<ValidationResults>

Events

ValidationChanged

public event Action? ValidationChanged

Event Type

Action

ValidationResultChanged

public event Action? ValidationResultChanged

Event Type

Action