Click here to Skip to main content
14,270,368 members

Extending the ASP.NET multiline TextBox control to limit the number of characters entered

Rate this:
4.74 (45 votes)
Please Sign up or sign in to vote.
4.74 (45 votes)
16 Nov 2007CPOL
Developers use multiline TextBox controls in almost all web projects. Since the MaxLength property of a TextBox control does not work when the TextMode property is set to Multiline, we usually use Validator controls to validate the length.


Developers use multiline TextBox controls in almost all web projects. Since the MaxLength property of a TextBox control does not work when the TextMode property is set to Multiline, we usually use Validator controls to validate the length. In this hands-on article, we are going to extend the TextBox control using JavaScript in order to limit the number of characters entered by the user to the length specified.

Using the code

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.IO;
using System.Globalization;
using System.Threading;

namespace CustomServerControls
    [ToolboxData("<{0}:TextArea runat="server"></{0}:TextArea>")]
    public class TextArea : TextBox
        public override TextBoxMode TextMode
                return TextBoxMode.MultiLine;

        protected override void OnPreRender(EventArgs e)
            if (MaxLength > 0)
                if (!Page.ClientScript.IsClientScriptIncludeRegistered("TextArea"))
                this.Attributes.Add("onkeyup", "LimitInput(this)");
                this.Attributes.Add("onbeforepaste", "doBeforePaste(this)");
                this.Attributes.Add("onpaste", "doPaste(this)");
                this.Attributes.Add("onmousemove", "LimitInput(this)");
                this.Attributes.Add("maxLength", this.MaxLength.ToString());

The code above creates a new TextArea custom server control by extending ASP.NET's TextBox control. By overriding the OnPreRender function, we include attributes to the HTML of the control. We add custom JavaScript and a property to pass MaxLength on the client side.

To show the working TextArea control, I prepared the following HTML:

<%@ Page Language="C#" AutoEventWireup="true" 

         CodeFile="Default.aspx.cs" Inherits="_Default" %>
<%@ Register TagPrefix="csc" Namespace="CustomServerControls" %> 

<html xmlns="" >
<head runat="server">
    <title>TextArea Custom Server Control with MaxLength property</title>
    <form id="form1" runat="server">
        <csc:TextArea id="TextArea" runat="server" 

            MaxLength="105" Rows="10" 


In the above HTML, I register the custom control with the web page by using the following line:

<%@ Register TagPrefix="csc" Namespace="CustomServerControls" %>

If you don't want to add the above registration line on each page that you use the TextArea control, you may add the following statement in the system.web section of the web.config file:

    <add tagPrefix="csc" namespace="CustomServerControls"></add>

I added the control on the page as:

<csc:TextArea id="TextArea" runat="server" MaxLength="105" Rows="10" Width="300px">

Let's compare the rendered output of a multiline textbox control and our text area control:

The rendered output of a standard multiple line ASP.NET TextBox is:

<textarea name="TextArea" id="TextArea" rows="10" cols="20" style="width:300px;" ></textarea>

The rendered output of our TextArea custom server control is:

<textarea name="TextArea" rows="10" cols="20" id="TextArea"

  onkeypress="LimitInput(this)" onbeforepaste="doBeforePaste(this)"

  onpaste="doPaste(this)" onmousemove="LimitInput(this)" maxLength="105"


The JavaScript event handlers doBeforePaste and doPaste are only implemented in Internet Explorer. These event handlers are used to check the length of characters that are pasted by using a mouse in Internet Explorer. Unfortunately, the doBeforePaste and doPaste event handlers are not defined in other browsers and we cannot catch a mouse paste in browsers other than IE. Therefore, I added an onmousemove event handler in order to check the length of characters that are pasted by using a mouse after a mouse move. The onkeypress event handler handles the standard character input.

function doBeforePaste(control)
   maxLength = control.attributes["maxLength"].value;
       event.returnValue = false;
function doPaste(control)
   maxLength = control.attributes["maxLength"].value;
   value = control.value;
        event.returnValue = false;
        maxLength = parseInt(maxLength);
        var o = control.document.selection.createRange();
        var iInsertLength = maxLength - value.length + o.text.length;
        var sData = window.clipboardData.getData("Text").substr(0,iInsertLength);
        o.text = sData;
function LimitInput(control)
    if(control.value.length >


  • Nov 10, 2007 - The onkeypress JavaScript event handler is changed with the onkeyup JavaScript event handler. (You may check the reason at KeyPress, KeyDown, KeyUp - The Difference Between JavaScript Key Events)
  • Nov 9, 2007 - Instead of using the 'ResolveClientUrl' method to access textarea.js which may cause a problem in the case of URL rewriting, the 'ResolveUrl' method is used.
  • The code is tested on Firefox, IE 6.0, and IE 7.0.

      Try the online demo of the extended ASP.NET multiline TextBox control that limits the number of characters entered. You may find more articles about ASP.NET, JavaScript, and C# on my blog.


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


About the Author

blogging developer
Web Developer
Blogging Developer is an accomplished project manager with more than 8 years of experience in web development, web strategy, e-commerce, and search engine optimization, specialized in object-oriented, multi-tiered design and analysis with hands-on experience in the complete life cycle of the implementation process including requirements analysis, prototyping, proof of concept, database design, interface implementation, testing, and maintenance.

Solid project management skills, expertise in leading and mentoring individuals to maximize levels of productivity, while forming cohesive team environments.

Comments and Discussions

BugMy vote of 5 Pin
zhangtai19-Sep-12 18:40
memberzhangtai19-Sep-12 18:40 
GeneralMy vote of 5 Pin
Manoj Kumar Choubey17-Feb-12 20:55
professionalManoj Kumar Choubey17-Feb-12 20:55 
GeneralWell Done Pin
norchr14-Apr-10 11:56
membernorchr14-Apr-10 11:56 
GeneralObject expected error while using this customer control into update panel [modified] Pin
Rakesh N Bhavsar22-Feb-10 0:34
memberRakesh N Bhavsar22-Feb-10 0:34 
GeneralNice Control Pin
thatraja19-Jan-10 3:14
protectorthatraja19-Jan-10 3:14 
QuestionDatabinding issues? Pin
mminnich28-Dec-09 5:27
membermminnich28-Dec-09 5:27 
GeneralSet MaxLength from CodeBehind Pin
Ken Robert Andersen7-May-09 23:34
memberKen Robert Andersen7-May-09 23:34 
GeneralThanks Pin
Grettir Strong6-Feb-09 7:34
memberGrettir Strong6-Feb-09 7:34 
GeneralNice Solution Pin
Alpha_Jujster2-Feb-09 3:02
memberAlpha_Jujster2-Feb-09 3:02 
Generalvalidation not working quite right Pin
HalfHuman7-Jan-08 1:13
memberHalfHuman7-Jan-08 1:13 
GeneralHi Pin
Srinath Gopinath24-Nov-07 8:01
memberSrinath Gopinath24-Nov-07 8:01 
QuestionWhy not just use a Regular Expression? Pin
orengold21-Nov-07 7:13
memberorengold21-Nov-07 7:13 
AnswerRe: Why not just use a Regular Expression? Pin
blogging developer21-Nov-07 10:03
memberblogging developer21-Nov-07 10:03 
GeneralRe: Why not just use a Regular Expression? Pin
orengold21-Nov-07 10:52
memberorengold21-Nov-07 10:52 
GeneralFirefox counts characters different from IE (AFAIK) [modified] Pin
Mark Cranness19-Nov-07 14:37
memberMark Cranness19-Nov-07 14:37 
Generalonkeypress Pin
Paulius9-Nov-07 2:10
memberPaulius9-Nov-07 2:10 
GeneralRe: onkeypress Pin
blogging developer9-Nov-07 22:53
memberblogging developer9-Nov-07 22:53 
QuestionResolveClientUrl problem? Pin
tvj088-Nov-07 6:14
membertvj088-Nov-07 6:14 
AnswerRe: ResolveClientUrl problem? Pin
blogging developer8-Nov-07 6:23
memberblogging developer8-Nov-07 6:23 
GeneralGood Pin
rajantawate1(http//www.tawateventures.com31-Oct-07 11:10
memberrajantawate1(http//www.tawateventures.com31-Oct-07 11:10 
Generaldesigner.vb Pin
aurand20-Sep-07 11:35
memberaurand20-Sep-07 11:35 
GeneralRe: designer.vb Pin
blogging developer20-Sep-07 21:42
memberblogging developer20-Sep-07 21:42 
GeneralRe: designer.vb Pin
aurand21-Sep-07 2:19
memberaurand21-Sep-07 2:19 
GeneralRe: designer.vb Pin
blogging developer21-Sep-07 2:26
memberblogging developer21-Sep-07 2:26 
GeneralRe: designer.vb Pin
aurand21-Sep-07 2:27
memberaurand21-Sep-07 2:27 

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

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

Posted 30 Aug 2007


79 bookmarked