Line Numbers for RichText Control in C#

Damian Suess

Rate me:

4.89/5 (22 votes)

11 Aug 2009CDDL3 min read

158.9K

7.4K

Display line numbers for rich text box with auto sizing. This is a converted version from another article written in VB.NET.

Download source - 25.65 KB

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)

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.0. If 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

Using SharpDevelop (3.x)

Create a new C# Windows project
Add Reference to your project (Right click 'References' > 'Add Reference')
Under GAC Tab select: "Microsoft.VisualBasic"
Insert into your project existing item.. "linenum_rtf.cs"
Under Custom Components, insert "LineNumbers_For_RichTextBox" into your form as well as insert a RichTextBox
Line them up side by side (left side by default)
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)
Run the project!

Using Visual Studio (2008)

Create a new C# Windows Project
Add Reference to your project (Right click 'References' > 'Add Reference')
Under .NET Tab select: "Microsoft.VisualBasic"
Insert the existing item into your project... "linenum_rtf.cs"
Build your project!
1. This will not show under Custom Components unless you build you the project first!
Under Custom Components, insert "LineNumbers_For_RichTextBox" into your form as well as insert a RichTextBox
Line them up side by side (left side by default)
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)
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)

Written By

Damian Suess

CEO Xeno Innovations, Inc.

United States

[ Exceeding the Limits of Imagination ]

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; }

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