Tuesday, June 22, 2010

Adding Validation to a Custom List Control in Sharepoint !


Recently, one of the requirements was to put validation to a custom list control such as Email field validation.

This validation can be achieved from inside the Sharepoint designer.

Following is a step by step walkthrough to validate a list field.


You should know how to create a Sharepoint list and how to open the site in Sharepoint designer.

  1. Following is a list with Email fields. Let's say we have to validate so that only a valid email can be entered.

    If not valid, then the Error Message appears next to the field:


  2. Now open the site in the Sharepoint designer and then expand the list and open the Newform.aspx of the list to be validated:


  3. As you can see in the image above, the Newform.aspx of Validation list is being opened in the Sharepoint designer.

  4. Now right click on this Validation list Web part in Sharepoint designer and choose Web Part properties:


  5. The properties dialog box will open for the Validation list here. Choose Hidden under layout and say OK.

    (This web part can be deleted as well, but due to some known problems because of deletion, it is best to hide this).


  6. Now click exactly underneath the hidden list web part and go to Insert->Sharepoint Controls-> Custom List Form… and the Wizard will ask to choose a List or Document Library form based on existing list.
    Choose your Validation list and select New item form under type of form to create option and hit Ok.


  7. You will get the Validation List underneath the hidden list as shown as selected image below:


  8. Now from here, we can customize all the controls based on requirement. As we are customizing the E-Mail field, right click on the email field box and choose Show common control tasks from the context menu:


  9. This will give you Common Formfield tasks option as shown below next to the Email field. Here we can change the format of the data field selected (default is List form field). As we need Email field to be textbox where validation can be applied, Choose Textbox from Format as dropdown instead of List form field.


  10. After the above step, List will look like this (custom formatted):


  11. Now drop a RegularExpressionValidator control from the Validation option under ASP.NET controls from the toolbar as shown below:


  12. Now specify the required properties (such as ControlToValidate, ErrorMessage, SetFocusOnError to true, Validate Expression) of the RegularExpressionValidator from the Tag Properties toolbar. For ControlToValidate, choose the ID of the Email field.

    After selecting it and getting the ID from the Tag Properties toolbar as you do in Visual Studio, see below the set attributes in blue for the Email field:


  13. Now, save the changes and go back to the list in Internet Explorer and try to type in an invalid email id and you will get the following:


Happy Sharepointing…


SharePoint Form Validation (Free Downloadable)

SharePoint Form Validation provides a way to validate input content when you create an item in New-Form or edit an item in Edit Form. By default, SharePoint can do some simple validations such as "Required Field" on server side when you submit form. But you often need validations of various kinds on client side. For example, when you create a task, you would like the form to warn you when your input on "Start Date" column is greater than "End Date" column before the data can be submitted to server. SharePoint Form Validation can help you to achieve it.
SharePoint Form Validation can be used on almost all kinds of lists. For most columns in the list, you can add standard validation methods such as "Required", "Compare", "Regular Expression" and "Range" validators etc. After configuration, the form validation will take effect in the New Form or Edit Form page.

SharePoint Form Validation

No comments:

Post a Comment