Validator.TryValidateObject Method (Object, ValidationContext, ICollection<ValidationResult>, Boolean)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Determines whether the specified object is valid and, if requested, validates all of the properties of the object.
Namespace: System.ComponentModel.DataAnnotations
Assembly: System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
Syntax
'Declaration
Public Shared Function TryValidateObject ( _
instance As Object, _
validationContext As ValidationContext, _
validationResults As ICollection(Of ValidationResult), _
validateAllProperties As Boolean _
) As Boolean
public static bool TryValidateObject(
Object instance,
ValidationContext validationContext,
ICollection<ValidationResult> validationResults,
bool validateAllProperties
)
Parameters
- instance
Type: System.Object
The object to validate.
- validationContext
Type: System.ComponentModel.DataAnnotations.ValidationContext
An object that contains information about the validation request.
- validationResults
Type: System.Collections.Generic.ICollection<ValidationResult>
A collection to store validation results.
- validateAllProperties
Type: System.Boolean
A value that indicates whether all immediate properties of the object are validated.
Return Value
Type: System.Boolean
true if the object is valid; otherwise, false.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | instance is nulla null reference (Nothing in Visual Basic). |
ArgumentException | instance does not equal the ObjectInstance on validationContext. |
Remarks
The TryValidateObject method evaluates each ValidationAttribute attribute that is attached to the object type to determine if the object is valid. The method also checks whether each property that is marked with RequiredAttribute attribute has a value. If validateAllProperties is set to true, the method validates the property values of the object.
If validationResults is nulla null reference (Nothing in Visual Basic), the method stops at the first validation failure. If validationResults is not nulla null reference (Nothing in Visual Basic), the method evaluates all validation attributes and adds all of the failures to validationResults. Class-level validation attributes are evaluated only if the property-level attributes are valid.
Version Information
Silverlight
Supported in: 5, 4, 3
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also