Click here to Skip to main content
Click here to Skip to main content

Line Numbers for RichText Control in C#

By , 11 Aug 2009
 

Introduction

Please wait while more details are being updated.

This article is a converted project from VB.NET to C#, originally created by nogChoco in the article, "LineNumbers for the RichTextBox".

Sure anyone can make a line numbering user control.  I've made many variations of them for VB 3.0 to 6.0 & C++, always using picture boxes or whatever as a drawing base to mark the position. When Microsoft released the newer versions of RichText control boxes (in more recent versions), the old methods went out the door.  By this, I mean that one can easily zoom in & out of the box by holding down Ctrl (or Shift) key while using the mouse wheel, posing a HUGE problem for traditional methods. 

Q: Why use RichText instead of the traditional TextBox?
A: (In older versions) RichText can hold more data! (and offers more features)

LineNumbers.png

Before Compiling Fore-note  

I have successfully compiled & ran this example project under both Visual Studio 2008 & SharpDevelop 3.x using Framework 2.0.

You will probably have problems running this example project under VS 2005 & lower; do note the control does work under the Framework 2.0If you are having problems running this under VS 2005 or other studios, you might want to either find yourself a project converter or upgrade your studio. I am very sorry if this is an inconvenience for you, that is why this is posted for Intermediate & Expert users. 

If you want a free IDE that can run this, try out SharpDevelop IDE.

Compiling Your Own Project

LineNumbers_-_ex3.png

Using SharpDevelop (3.x) 

  1. Create a new C# Windows project
  2. Add Reference to your project (Right click 'References' > 'Add Reference')
  3. Under GAC Tab select: "Microsoft.VisualBasic"
  4. Insert into your project existing item.. "linenum_rtf.cs"
  5. Under Custom Components, insert "LineNumbers_For_RichTextBox" into your form as well as insert a RichTextBox
  6. Line them up side by side (left side by default)
  7. Link Line Numbers to your RichTextBox
    1. Under "Add LineNumbers to" > "Parent Rich Text Box":
    2. Select your RichTextBox to add line numbers to
    3. (feel free to customize it on your own)
  8. Run the project!

Using Visual Studio (2008)

  1. Create a new C# Windows Project
  2. Add Reference to your project (Right click 'References' > 'Add Reference')
  3. Under .NET Tab select: "Microsoft.VisualBasic"
  4. Insert the existing item into your project... "linenum_rtf.cs"
  5. Build your project!
    1. This will not show under Custom Components unless you build you the project first!
  6. Under Custom Components, insert "LineNumbers_For_RichTextBox" into your form as well as insert a RichTextBox
  7. Line them up side by side (left side by default)
  8. Link Line Numbers to your RichTextBox
    1. Under "Add LineNumbers to" > "Parent Rich Text Box":
    2. Select your RichTextBox to add line numbers to
    3. (feel free to customize it on your own)
  9. Run the project!

Background and Points of Interest

As a software designer/developer like all of you, time is of the essence when meeting deadlines! This example using the RichText control works great! Especially with the zoom in/out feature using the mouse wheel, and it added nice graphical features which can be easily customized. However, I feel the urging need to program in C# and this example was only provided in VB.NET... It was time to upgrade it & now, on with the show!

History

  • 2009.08.05 - Initial conversion from VB.NET to C#
  • 2009.08.08 - Updated notes on this page (pictures soon to come)

To Do

  • Provide 2 versions
    • Graphical: The current version (customizable and beautiful)
    • Simple: Side bar is simple & has low overhead on your projects
  • Strip out references to Microsoft.VisualBasic so it's more pure C#

- Damian J. Suess of Xeno Innovations, Inc. [2000-2009]

License

This article, along with any associated source code and files, is licensed under The Common Development and Distribution License (CDDL)

About the Author

Damian J. Suess
CEO Xeno Innovations, Inc.
United States United States
Member
[ Exceeding the Limits of Imagination ]

Sign Up to vote   Poor Excellent
Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

 
You must Sign In to use this message board.
Search this forum  
    Spacing  Noise  Layout  Per page   
QuestionGoodmemberElegiac19 May '13 - 21:45 
but can i do it without using the reference tool?
 
and just a code?
QuestionVisual Studio 11 supportmemberverber0017 Jun '12 - 17:11 
Will this work under VS11? I've added a reference to VSB but can't seem to add linenum_rtf.cs under existing items.
GeneralMy vote of 5memberPanki_17 Oct '11 - 20:36 
It is very good! But I still have problems with displaying line numbers with big text files :(
Generalstatic 'Main' method not suitable for an entry pointmember501st_commander26 Apr '10 - 10:10 
When i add the files and rebuild i get this:
Error 1 Program 'C:\Users\{username}\Documents\Visual Studio 2008\Projects\c#\luaediter\Lua Editer\obj\Release\Lua Editer.exe' does not contain a static 'Main' method suitable for an entry point
 
i am using Visual C# express 2008. Any ideas?
QuestionLicense???memberTannner.R9 Apr '10 - 13:18 
Does you custom control have some type of license or can people use it for personal and commercial use free? Big Grin | :-D
AnswerRe: License???memberDamian J. Suess10 Apr '10 - 7:02 
Go for it! The only thing i ask is a small line of some sort of, "thank you" in the credits.
 
Please let me know of the product that it is being used in (even if the code was re-vamped and changed). This way I can post Success Stories/Projects. In return this can possibly help generate more traffic or recognition for you.
 
Best of luck to you and your project!
 

- Damian
-code monkey-

GeneralRe: License???memberTannner.R10 Apr '10 - 7:10 
OK cool, I'll let you know shortly if I decide to use it. Big Grin | :-D
GeneralRe: License???memberTannner.R5 May '10 - 8:41 
Hey, man your control was just to good to pass up! I decided to use it in my HTML Editor you can see it here on SourceForge: <HTML> Editor I also put a link to this page in the credits. Big Grin | :-D
 
NOTE: The current version of <HTML> Editor is v0.6, line numbers are not coming until v0.7 which should be out with in the week so check back Cool | :cool:
GeneralOne more thing - if you want to solicit input and maintain changes...memberCheeso31 Mar '10 - 13:25 
Consider putting this control into a small project on codeplex.com.
 
You'd then be able to accept patches from people, and apply changes, accept and manage change requests, do versioning, and so on.
 
It sounds like a whole lot of extra work, but it's really not, after you get it set up.
Questionline numbers disappear when the # of lines is large?memberCheeso31 Mar '10 - 13:23 
I noticed that the line numbers seemed to disappear when I displayed an RTB with hundreds of lines. ??
 
I looked in Update_SizeAndPosition() and found that the edge of the linenumbers control was being moved outwards, either left or right, depending on how it was docked to the parent RTB. When there were, say, 4 digits to display, and the linenumbers control was displayed on the left, the left edge of it would move further leftward. This became a problem when the control was anchored to the left edge of the form.
 
So I reworked the Update_SizeAndPosition() method, based on the principle that the bounding box of the linenumebers control plus its parent should not change, regardless of how wide the digits display could become. In other words, when docked to the left of the RTB, the left edge of the linenumbers control should never move further leftward, and the right edge of the RTB should never move further rightward.
 
Conversely, when docked to the right edge of the RTB, the right edge of the linenumbers control should nevevr move further rightward, and the left edge of the RTB should never move further leftward. If that makes sense.
 
The only movement, then, should be on the internal borderline, between the two controls. As the linenumbers control needs to expand, the RTB should shrink, horizontally.
 
The modified code looks like this:
 
else if (zDockSide != LineNumberDockSide.None)
{
    // --- DockSide is active L/R/H

    // line up the tops of the numbers and the RTB
    zNewLocation.Y = zParent.Top;
    zNewSize.Height = zParent.Height;
 
    // Principle: keep the overall size of the RTB and
    // the RtbLineNumbers, the same.
    // --------------------------------------------
    // The left edge of the RtbLineNumbers must remain
    // fixed when it is displayed to the left.  The
    // right edge of the RtbLineNumbers when it is
    // displayed to the right.
    // --------------------------------------------
    //
    // Corollary: only move the border between the two.

    if (zAutoSizing_Size.Width > 0)
        zNewSize.Width = zAutoSizing_Size.Width;
 
    int delta = zNewSize.Width - this.Size.Width;
 
    if (delta == 0) return; // no change!

 
    var newParentSize = zParent.Size;
    newParentSize.Width = newParentSize.Width - delta;
 
    if (zDockSide == LineNumberDockSide.Left)
    {
        // The line numbers appear to the left of the RTB.

        // For the left edge to remain fixed,
        // this.Location.X  must remain constant.
        // Move the left border of the RTB and resize it,
        // as necessary.

        var newParentLoc = zParent.Location;
        newParentLoc.X = zNewLocation.X + zNewSize.Width + 1;
        zParent.Location = newParentLoc;
    }
    else if (zDockSide == LineNumberDockSide.Right)
    {
        // The line numbers appear to the right of the RTB.

        // For the right edge to remain fixed,
        // this.Location.X + this.Width must remain constant
        // Move the right border of the RTB as necessary (hence,
        // resize it).
        zNewLocation.X = this.Location.X - delta;
    }
    zParent.Size = newParentSize;
    this.Location = zNewLocation;
    this.Size = zNewSize;
}

AnswerRe: line numbers disappear when the # of lines is large?memberDamian J. Suess10 Apr '10 - 7:05 
Thank you for the update! Testing it out now. I'm still unhappy with the overall update mechanism in general. Don't get me wrong, your contribution was awesome! Smile | :)
 
Going to look into different routes of updating the line count with as little over-head as possible. As we all noticed, it begins to choke a little after ~15000 lines.
-code monkey-

GeneralRe: line numbers disappear when the # of lines is large?memberCheeso20 Apr '10 - 4:14 
Damian, after looking at this further, I thought to try a different tack.
Rather than defining a companion control, as you did here, I extended RichTextBox. This RichTextBoxEx displays line numbers itself, within its bounds, in response to the Paint event. Some pictures.
 
http://i39.tinypic.com/13zcoz6.jpg[^]
 
http://i43.tinypic.com/wml2z9.jpg[^]
 
http://i39.tinypic.com/25i4x3o.jpg[^]
 
It scrolls cleanly, it's fast.
 
You can get the code to see what I did, here:
http://xpathvisualizer.codeplex.com/SourceControl/changeset/view/42057#823009[^]
 
Also this one is under source control, so if anyone wants to submit requests or bugs, it's available to you.
BugRe: line numbers disappear when the # of lines is large?memberHirnhamster16 Jan '12 - 2:10 
First of all, great work Smile | :) Really helped me a lot Wink | ;)
 
But there are two minor bugs in your code:
1. If the first character is a New-Line, the first line number is "2" instead of "1". I fixed it by changing
 
private int FirstVisibleTextLine
 {
     get
     {
         int c = GetCharIndexFromPos(1,1);
         for (int i=0; i < CharIndexForTextLine.Length; i++)
         {
             if (c < CharIndexForTextLine[i]) return i;
         }
         return CharIndexForTextLine.Length;
     }
 }
 
to
 
private int FirstVisibleTextLine
 {
     get
     {
         int c = GetCharIndexFromPos(1,1);
         for (int i=0; i < CharIndexForTextLine.Length; i++)
         {
             if (c <= CharIndexForTextLine[i]) return i;
         }
         return CharIndexForTextLine.Length;
     }
 }
 
(replacing c < by c <=) - I have not tested this exhaustively, but I didn't face any problems with this solution so far.
 
2. If the line-numbers increase the number of digits (e.g. from 9 to 10), the size of the line-number-space is not calculated correctly. If you add another line (e.g. from 10 to 11), it works as expected.
 
As a solution, I changed
 
private int LineNumberWidth
{
    get
    {
        if (_lnw > 0) return _lnw;
        if (NumberLineCounting == LineCounting.CRLF)
        {
            _ndigits = (CharIndexForTextLine.Length == 0)
                ? 1
                : (int)(1 + Math.Log((double)CharIndexForTextLine.Length, 10));
        }
//...
}
 
to
 
private int LineNumberWidth
{
    get
    {
        if (_lnw &gt; 0) return _lnw;
        if (NumberLineCounting == LineCounting.CRLF)
        {
            _ndigits = (CharIndexForTextLine.Length == 0)
                ? 1
                : (int)(1 + Math.Log((double)CharIndexForTextLine.Length+1, 10));
        }
//...
}
 
(adding a "+1" before calculating the log10, because _n-New Line's correspond to _n+1 displayed lines)
 
Hope that helps Smile | :)
 
Cheers
Pascal
QuestionI cant find the controlmemberAlexanderBorup27 Feb '10 - 13:50 
I cant find the control for the LineNumbers
 
I am using Visual C# 2008 Express Edition,
I have added a reference for Microsoft VisualBasic,
I have added the linenum_rtf.cs
 
So why doesn't it show?
AnswerRe: I cant find the controlmemberDamian J. Suess28 Feb '10 - 8:24 
Did you check the requirements over all of the requirements? The most common mistake made by most is, You must compile your program after adding the file & the reference. After that, the control will be visible and able to be used.
 
One side note, this was never tested under Express Edition. If you do not have the funds or means to have a full version of Visual Studio (2005/2008/2010) feel free to try, SharpDevelop at www.icsharpcode.net It is a completely free, full packed alternative to MS Visual Studio.
 
Best of luck to you, hope this helps
 
- Damian
-code monkey-

Generalsome mod's to make it a bit more c#:memberRob24121 Jan '10 - 21:38 
replace: DateAndTime with DateTime
 
insert: string CrLf = Environment.NewLine;
 
replace: Constants.vbCrLf with CrLf
 
replace: Strings.Chr(10) with (char)10
 
delete: using Microsoft.VisualBasic;
GeneralRe: some mod's to make it a bit more c#:memberDamian J. Suess2 Jan '10 - 5:22 
thank you for your feedback & hints
 
-code monkey-

QuestionWhen it is a lot of linesmemberrave4ka5 Oct '09 - 7:31 
When I load about 27k lines, there is good bugs. Programm work very slowly. How can I fix it?
sorry for my english.
AnswerRe: When it is a lot of linesmemberDamian J. Suess2 Jan '10 - 5:21 
that was heavily looked into.. ran a debug on a few of the recursive functions & it does call itself a lot! The issue lies when trying to get the sum & individual height of each line in the file. If this was a fixed height box like most code boxes, this issue wouldn't arise.
 
I am always open to suggestions! Maybe if we had the RTF box set as a fix-font, this would help lower the impact of this issue.
 
-code monkey-

GeneralRe: When it is a lot of linesmemberCheeso31 Mar '10 - 13:16 
I looked into this as well. Found that the TextChanged() method gets called very very often. I had coupled this with a RTB that was displaying XML, and also formatting the XML with syntax highlighting. With every format change, the zParent_Changed method was being invoked, which then invalidated the control and caused a repaint.
 
That didn't work out so well. Definitely need a way to distinguish between types of changes and be more intelligent about re-painting. It's possible you could use a backoff timer. If you get 72 zParent_Changed() calls in a row, wait.... until they stop coming. And only do the refresh/invalidate after a short delay when no further zParent_Change events occur. Haven't tested this, it's only an idea.
 
The other thing: inside Update_VisibleLineNumberItems(), there are a number of things that can be easily optimized. For one thing, every retrieval of zParent.Text is expensive. So, retrieve it once at the top of the method and replace all zParent.Text with a reference to the local copy. Like this:
 
    if (zParent == null)
        return;
 
    string txt = zParent.Text; // getting the text is expensive. We do it once.

    if (string.IsNullOrEmpty(txt))
        return;
    ...
 
For another thing, the timer in that method is sort of odd. It's very simple to replace it with a stopwatch. Not sure if that's a performance thing, but it makes the code cleaner.
 
    var stopwatch = new Stopwatch();
    stopwatch.Start();
    ....
 
        if (zParentIsScrolling == true && stopwatch.ElapsedMilliseconds > 500)
        {
 
 
Finally, counting the lines is done via a call to String.Split() , which produces an array of strings. Then the .Length property is retrieved on that array.
 
   zSplitStartLine = Math.Max(0, zParent.Text.Substring(0, zStartIndex).Split("\r\n".ToCharArray()).Length - 1);
 

This is very inefficient, if all you want to know is how many \n characters are in the string. Replace that with a simple utility method that iterates through the chars of the string.
 
  private static int CountNewlines(string s)
  {
      int len = s.Length;
      int c = 0;
      for (int i=0; i < len;  i++)
      {
          if (s[i] == '\n') c++;
      }
      return c+1;
  }
 
  ...
 
    zSplitStartLine = Math.Max(0, CountNewlines(txt.Substring(0, zStartIndex)) - 1);
 
 
With these changes, the control is much more usable for me for RTB's with larger content.
 

Thanks for the control, though. Very very useful.
QuestionRe: When it is a lot of linesmemberPanki_17 Oct '11 - 20:27 
I used this Control and it is very good. But I still have problems with displaying numbers of lines with big text file. I made changes described in previous answer without counting zParent_Changed().
I have a text file with more then 1000 of lines, 50-100 characters in line.
What can I do to adjust performance? Can this counting zParent_Changed() help this much?
Generalvery good.memberZielonekk4 Sep '09 - 0:01 
Thanks a lot
GeneralGet the line number when clicking on the controlmemberkenneth_cwc22 Aug '09 - 5:54 
Are there any ways to get the line number when I click on the control?
 
Thanks~
GeneralMy vote of 5memberarvindjo11 Aug '09 - 23:33 
Awesome!!!
GeneralJust on time...memberPaul Selormey10 Aug '09 - 14:34 
Just getting ready to use that control, and thanks for getting it ready for me.
 
Best regards,
Paul.
 

Jesus Christ is LOVE! Please tell somebody.

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

Permalink | Advertise | Privacy | Mobile
Web01 | 2.6.130516.1 | Last Updated 11 Aug 2009
Article Copyright 2009 by Damian J. Suess
Everything else Copyright © CodeProject, 1999-2013
Terms of Use
Layout: fixed | fluid