ValidatingPropertiesEventArgs.FailedProperties Property

Definition

Namespace:

System.Web.ApplicationServices

Assembly:

System.Web.Extensions.dll

Gets the collection that contains profile properties that have failed validation.

public:
 property System::Collections::ObjectModel::Collection<System::String ^> ^ FailedProperties { System::Collections::ObjectModel::Collection<System::String ^> ^ get(); };

public System.Collections.ObjectModel.Collection<string> FailedProperties { get; }

member this.FailedProperties : System.Collections.ObjectModel.Collection<string>

Public ReadOnly Property FailedProperties As Collection(Of String)

Property Value

Collection<String>

The profile properties that have failed validation.

Examples

The following example shows an event handler for the ValidatingProperties event. When the value passed for FirstName property is empty or null, the FirstName property is added to the FailedProperties collection.

void Application_Start(object sender, EventArgs e) 
{
    System.Web.ApplicationServices.ProfileService.ValidatingProperties += new EventHandler<System.Web.ApplicationServices.ValidatingPropertiesEventArgs>(ProfileService_ValidatingProperties);
}

void ProfileService_ValidatingProperties(object sender, System.Web.ApplicationServices.ValidatingPropertiesEventArgs e)
{
    if (String.IsNullOrEmpty((string)e.Properties["FirstName"]))
    {
        e.FailedProperties.Add("FirstName");
    }
}

Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    AddHandler System.Web.ApplicationServices.ProfileService.ValidatingProperties, _
      AddressOf ProfileService_ValidatingProperties
End Sub

Sub ProfileService_ValidatingProperties(ByVal sender As Object, ByVal e As System.Web.ApplicationServices.ValidatingPropertiesEventArgs)
    If (String.IsNullOrEmpty(CType(e.Properties("FirstName"), String))) Then
        e.FailedProperties.Add("FirstName")
    End If
End Sub

Remarks

The FailedProperties property contains a collection of the names of the properties that have failed validation. If you create an event handler for the ValidatingProperties event, you add the names of the properties that fail validation to the collection in the FailedProperties property. The SetPropertiesForCurrentUser method returns the collection in the FailedProperties property so that you can determine which properties failed validation.