Click here to Skip to main content
11,631,212 members (70,069 online)
Click here to Skip to main content

Multiline TextBox with MaxLength Validation

, 12 Mar 2006 CPOL 156.9K 354 45
Rate this:
Please Sign up or sign in to vote.
A simple extension of the existing TextBox control to attach JavaScript for maxlength validation.

Introduction

In almost all web projects, we require a multiline TextBox control. It was annoying to find that the maxLength property doesn't work on multiline textboxes. There are various solutions suggesting to use validator controls to validate length. I suggest that we should put a validator as well as extend our control so that the user will not be able to enter characters more than the length specified.

Extending the TextBox

To achieve this, I tried extending the ASP.NET TextBox WebControl.

using System;
using System.Collections.Generic;
using System.Text;
using System.Web.UI.WebControls;

namespace CustomWebControls
{
    /// <summary>
    /// Extended TextBox control that applies
    /// javascript validation to Multiline TextBox
    /// </summary>
    public class TextArea: TextBox
    {
        /// <summary>
        /// Override PreRender to include custom javascript
        /// </summary>
        /// <param name="e"></param>
        protected override void OnPreRender(EventArgs e)
        {
            if (MaxLength > 0 && TextMode == TextBoxMode.MultiLine)
            {
                // Add javascript handlers for paste and keypress
                Attributes.Add("onkeypress","doKeypress(this);");
                Attributes.Add("onbeforepaste","doBeforePaste(this);");
                Attributes.Add("onpaste","doPaste(this);");
                // Add attribute for access of maxlength property on client-side
                Attributes.Add("maxLength", this.MaxLength.ToString());
                // Register client side include - only once per page
                if(!Page.ClientScript.IsClientScriptIncludeRegistered("TextArea"))
                {
                    Page.ClientScript.RegisterClientScriptInclude("TextArea", 
                        ResolveClientUrl("~/js/textArea.js"));
                }
            }
            base.OnPreRender(e);
        }
    }
}

Now our custom control is ready to use. In the above code block, it should be self-explanatory that if I find the TextBox's TextMode property to be MultiLine, I add custom JavaScript and a property to pass the maxLength on the client side. I take advantage of ClientScript to attach a JavaScript, only one per page. I chose to include JavaScript as an external file because this allows us to modify the JavaScript easily. In addition, the page will not be bloated and the script will be cached.

I created this control in a Project Library so that I can use this control in any of our projects.

JavaScript File

// Keep user from entering more than maxLength characters
function doKeypress(control){
    maxLength = control.attributes["maxLength"].value;
    value = control.value;
     if(maxLength && value.length > maxLength-1){
          event.returnValue = false;
          maxLength = parseInt(maxLength);
     }
}
// Cancel default behavior
function doBeforePaste(control){
    maxLength = control.attributes["maxLength"].value;
     if(maxLength)
     {
          event.returnValue = false;
     }
}
// Cancel default behavior and create a new paste routine
function doPaste(control){
    maxLength = control.attributes["maxLength"].value;
    value = control.value;
     if(maxLength){
          event.returnValue = false;
          maxLength = parseInt(maxLength);
          var oTR = control.document.selection.createRange();
          var iInsertLength = maxLength - value.length + oTR.text.length;
          var sData = window.clipboardData.getData("Text").substr(0,iInsertLength);
          oTR.text = sData;
     }
}

Using the Custom Control

To test the custom control, I created a test website and added a reference to the project. I wanted to avoid the hassle of adding the Register tag on each page, so I went ahead and added the following statements in the system.web section of web.config.

<pages>
   <controls>
    <add tagPrefix="CustomControls" 
      namespace="CustomWebControls" 
      assembly="CustomWebControls"></add>
   </controls>
</pages>

Now I created a test web page and added the control on the page as:

<CustomControls:TextArea runat="server" ID="testTextArea" 
   MaxLength="10" TextMode="MultiLine"></CustomControls:TextArea>

Then I added the JavaScript file in the JS folder.

Tested the solution and voila! My first attempt to create an extended custom Web Control is successful. I will appreciate your comments.

Summary of things I learned

  • Extending a Web Control is a breeze.
  • The new ClientScript property of Page. And the related IsClientScriptIncludeRegistered and RegisterClientScriptInclude properties.
  • Added the tag prefix in Web.Config instead of specifying it on each page.

Client Browsers Supported

  • IE 6.0

Other Notes

  • To get this control to work on other browsers also, we might need some modifications in the JS file.
  • This solution was developed in Visual Studio 2005. To convert it to Visual Studio 2003, we just need to change the calls for IsClientScriptIncludeRegistered and RegisterClientScriptInclude.
  • It's necessary to add validation controls also for length check. This will allow you to validate the input even if client-side script fails.

Thanks CodeProject for all the help!

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Yen Dutt
Web Developer Airtel Broadband
India India
Despite my lack of interest, started trying coding at the age of 15 in Visual FoxPro. Got introduced to ASP in 2003 and started working for a US based client for a Youth Sports Management Application. In 2005, got Introduced to ASP.NET/ VB.NET and since then, it has become my passion. Recently joined Rapidigm Inc. as a software developer and looking forward to expand my knowledge base by sharing information with fellow coders in the Web World.

My interests include listening to music, trekking, traveling apart from coding!

You may also be interested in...

Comments and Discussions

 
QuestionThanks Pin
tidkerohit12-Oct-11 3:18
membertidkerohit12-Oct-11 3:18 
GeneralWell done thanks Pin
Melih Gümüşçay18-Jul-09 3:32
memberMelih Gümüşçay18-Jul-09 3:32 
RantRe: Well done thanks Pin
hfrmobile3-Mar-10 23:06
memberhfrmobile3-Mar-10 23:06 
GeneralClient code work on ff & ie Pin
ramip4-Apr-09 1:25
memberramip4-Apr-09 1:25 
Generalgud 1 : Multiline TextBox with MaxLength Validation Pin
Coder Sumi1-Feb-09 23:51
memberCoder Sumi1-Feb-09 23:51 
GeneralI'm sorry, but forget about TextArea behaving like a TextBox. Firefox / IE / Chrome [modified] Pin
violentkun12-Dec-08 2:25
memberviolentkun12-Dec-08 2:25 
QuestionWhy not use a Regular Expression Validator? Pin
Joe Gakenheimer )23-Jun-08 2:26
memberJoe Gakenheimer )23-Jun-08 2:26 
GeneralProblems w/ AJAX update panels Pin
JoAnn Morse31-May-08 8:13
memberJoAnn Morse31-May-08 8:13 
GeneralRe: Problems w/ AJAX update panels Pin
Astynax77727-Dec-08 7:50
memberAstynax77727-Dec-08 7:50 
GeneralThanks Pin
carladinmc14-Apr-08 2:32
membercarladinmc14-Apr-08 2:32 
GeneralFixed for Firefox Pin
Member 436197826-Feb-08 2:16
memberMember 436197826-Feb-08 2:16 
GeneralRe: Fixed for Firefox Pin
jmoore653-Mar-08 3:57
memberjmoore653-Mar-08 3:57 
GeneralRe: Fixed for Firefox Pin
hfrmobile3-Mar-10 23:05
memberhfrmobile3-Mar-10 23:05 
GeneralNew line Pin
Astynax77720-Feb-08 7:52
memberAstynax77720-Feb-08 7:52 
GeneralRe: New line Pin
sar11234-Sep-09 10:27
membersar11234-Sep-09 10:27 
GeneralRe: New line Pin
Astynax7774-Sep-09 10:47
memberAstynax7774-Sep-09 10:47 
GeneralFirefox Pin
halexic30-Mar-07 1:32
memberhalexic30-Mar-07 1:32 
GeneralRe: Firefox Pin
hfrmobile3-Mar-10 23:19
memberhfrmobile3-Mar-10 23:19 
QuestionUpdatePanel Pin
jlweand13-Mar-07 22:24
memberjlweand13-Mar-07 22:24 
GeneralGreat work, paste issue Pin
Juan Martin23-Jan-07 9:27
memberJuan Martin23-Jan-07 9:27 
GeneralThank you very much Pin
msg2rk17-Jan-07 20:43
membermsg2rk17-Jan-07 20:43 
GeneralError Pin
mishenkovks8-Nov-06 23:25
membermishenkovks8-Nov-06 23:25 
Generalthanx for the article... another nice solution... Pin
Sina Falahati31-Oct-06 7:59
memberSina Falahati31-Oct-06 7:59 
GeneralRe: thanx for the article... another nice solution... Pin
Yen Dutt31-Oct-06 17:48
memberYen Dutt31-Oct-06 17:48 
GeneralRe: thanx for the article... another nice solution... Pin
Sina Falahati1-Nov-06 3:13
memberSina Falahati1-Nov-06 3:13 
GeneralExtending Textbox to open the default email-client on the client side Pin
Chakreee4-Sep-06 20:57
memberChakreee4-Sep-06 20:57 
GeneralStandard JavaScript Pin
Deobrat Singh28-Aug-06 23:59
memberDeobrat Singh28-Aug-06 23:59 
GeneralRe: Standard JavaScript Pin
Avornicesei Simona5-Sep-06 2:05
memberAvornicesei Simona5-Sep-06 2:05 
GeneralRe: Standard JavaScript Pin
Chris Gruber9-Aug-07 2:12
memberChris Gruber9-Aug-07 2:12 
AnswerAnother solution Pin
abaif15-Mar-06 3:09
memberabaif15-Mar-06 3:09 
GeneralRe: Another solution Pin
Durlabh17-Mar-06 9:44
memberDurlabh17-Mar-06 9:44 
GeneralRe: Another solution Pin
rlivelyppk17-Mar-06 9:54
memberrlivelyppk17-Mar-06 9:54 
GeneralRe: Another solution more EASY Pin
ejgarci5-Jun-08 17:52
memberejgarci5-Jun-08 17:52 
RantRe: Another solution more EASY Pin
rlivelyppk11-Jun-08 6:57
memberrlivelyppk11-Jun-08 6:57 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.150723.1 | Last Updated 12 Mar 2006
Article Copyright 2006 by Yen Dutt
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid