Click here to Skip to main content
15,313,527 members
Articles / Mobile Apps
Article
Posted 29 May 2005

Stats

909.3K views
12.2K downloads
224 bookmarked

Syntax highlighting textbox written in C#

Rate me:
Please Sign up or sign in to vote.
4.78/5 (81 votes)
13 Jul 20053 min read
This article describes the code of a RichTextBox that knows how to highlight parts of the text and provide auto-completion.

Sample Image

Introduction

Hey. This code is a class derived from .Net's RichTextBox. It offers syntax highlighting and auto-completion features (like Intellisense, only a little dumber).

Background

Have you ever written an application that had its own script language? Ever needed to edit SQL/code in you application? Didn't you just want a control that was a little better than a TextBox with a fixed width font? Now you can have it :-)

This control was written when I needed to edit SQLs in an application I wrote. Then I thought:

"Even if I could find a control that knows to edit SQLs well, it still wouldn't highlight names of tables or stored procedures that I wrote. And I know I'll need a control that can highlight my own script language sometime..."

So I sat down and wrote it. Later I realized that syntax highlighting without an auto-completion is not worth much, so I added support for that too.

Using the code

First of all, I must apologise. I'm not much of a GUI programmer, so all of the manipulation is done using code, as I lack the knowledge to write custom editors for a PropertyGrid. With that out of the way, we may continue! The control has two inputs for highlighting:

  1. Separators: Accessed using the Seperators property.

    Each separator is a char, and what is later refferd to as "token" is a not-empty string between separators.

  2. Highlight Descriptor: You can use the (how surprising) HighlightDescriptor method to add a HighlightDescriptor.

    A HighlightDescriptor is an instance of a class describing a highlighting rule, which can be divided into token identification info and design info.

Highlighting Rules

A highlighting rule has 6 fields it's constructed with:

  • Token: A string that is later compared to the text.
  • DescriptorType: Sets the highlighting type. The options are in a single word, to the end of the line, and to the corresponding closing token.
  • DescriptorRecognition: Determines how the token is compared to the token from the text. The options are: the text is equal to the token, the text begins with the token, and the text contains the token.
  • Color: Sets the color of the token when highlighted.
  • Font: Sets the font on the token when highlighted. This field is optional.
  • UseForAutoComplete: Determines if the token will be used for auto completion.

Due to laziness, a HighlightDescriptor's values can only be set in the constructor. <SideNote> I really think that the readonly keyword is under appreciated.</SideNote>.

The HighlightDescriptor is as follows:

C#
public class HighlightDescriptor
{
    public HighlightDescriptor(string token,
           string closeToken, Color color, Font font,
           DescriptorType descriptorType, DescriptorRecognition dr,
           bool useForAutoComplete)
    {
        Color = color;
        Font = font;
        Token = token;
        DescriptorType = descriptorType;
        CloseToken = closeToken;
        DescriptorRecognition = dr;
        UseForAutoComplete = useForAutoComplete;
    }

    public readonly Color Color;
    public readonly Font Font;
    public readonly string Token;
    public readonly string CloseToken;
    public readonly DescriptorType DescriptorType;
    public readonly DescriptorRecognition DescriptorRecognition;
    public readonly bool UseForAutoComplete;
}

Points of Interest

There were a few interesting things during the writing:

  1. Scrollbars: Since every time the text changes, I actually change it again (as far as the base textbox knows), the scrollbars reset themselves to top and left most positions. To resolve this, I used the EM_GETSCROLLPOS and EM_GETSCROLLPOS Windows messages:
    C#
    #region Scrollbar positions functions
    /// <summary>
    /// Sends a win32 message to get the scrollbars' position.
    /// </summary>
    /// <returns>a POINT structre containing horizontal
    ///       and vertical scrollbar position.</returns>
    private unsafe Win32.POINT GetScrollPos()
    {
        Win32.POINT res = new Win32.POINT();
        IntPtr ptr = new IntPtr(&res);
        Win32.SendMessage(Handle, Win32.EM_GETSCROLLPOS, 0, ptr);
        return res;
    
    }
    
    /// <summary>
    /// Sends a win32 message to set scrollbars position.
    /// </summary>
    /// <param name="point">a POINT
    ///        conatining H/Vscrollbar scrollpos.</param>
    private unsafe void SetScrollPos(Win32.POINT point)
    {
        IntPtr ptr = new IntPtr(&point);
        Win32.SendMessage(Handle, Win32.EM_SETSCROLLPOS, 0, ptr);
    
    }
    #endregion
    
  2. Keyboard strokes: During my work on the auto complete feature, I found out that even if you override the OnKeyDown method and not call the base method, keystrokes of keys containing actual characters are still handled (they arrive using the WM_CHAR message). Due to that I decided to override the WndProc method and filter unwanted keystrokes at that level.
  3. RTF: I didn't really learn RTF for this project. I just took a regular RichTextBox and understood what I have to build for my needs. Hence my resulting RTF is probably not optimal. It probably has language limitations that can be solved fairly easily by manipulating the RTF header.

History

  • 05/29/2005: First release.
  • 04/06/2005: Fixed a few bugs when using the ToCloseToken DescriptorType.
  • 07/13/2005: Fixed a few bugs, added Undo/Redo functionality.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Uri Guy
Web Developer
Israel Israel
Hey.
I've been programming since I first understood english at age 10, starting with QBASIC.
I've been developing production C# applications since .Net's first beta, and I enjoy every second of it, as I enjoy sailing, kitesurfing, and playing guitar.

Comments and Discussions

 
GeneralHelp Required Pin
Niraj Dutt9-Aug-07 4:54
MemberNiraj Dutt9-Aug-07 4:54 
GeneralRe: Help Required Pin
kabwla26-Nov-07 13:00
Memberkabwla26-Nov-07 13:00 
QuestionNon-ansi characters are displayed as ?? Pin
Sin Jeong-hun6-Aug-07 6:30
MemberSin Jeong-hun6-Aug-07 6:30 
QuestionHow set a Highlight Descriptor BackColor? Pin
Wagner Araujo24-Jul-07 15:16
MemberWagner Araujo24-Jul-07 15:16 
GeneralSeparators in HighlightDescriptors Pin
nyctalinth16-Jul-07 9:04
Membernyctalinth16-Jul-07 9:04 
GeneralRe: Separators in HighlightDescriptors Pin
JoanComasFdz18-Sep-07 1:34
MemberJoanComasFdz18-Sep-07 1:34 
Questionhow to set the SelectionBackColor Pin
Ishkmi16-Jul-07 7:32
MemberIshkmi16-Jul-07 7:32 
GeneralProblem with XML Pin
Darkas215-Jul-07 5:27
MemberDarkas215-Jul-07 5:27 
GeneralRe: Problem with XML Pin
JoanComasFdz18-Sep-07 1:23
MemberJoanComasFdz18-Sep-07 1:23 
Generalautocomplete feature is not working Pin
Adobe200726-Apr-07 5:53
MemberAdobe200726-Apr-07 5:53 
GeneralRe: autocomplete feature is not working Pin
Adobe200728-Apr-07 13:19
MemberAdobe200728-Apr-07 13:19 
Questionhow to do this? Pin
simply_joe10-Apr-07 19:36
Membersimply_joe10-Apr-07 19:36 
AnswerRe: how to do this? Pin
JoanComasFdz18-Sep-07 1:16
MemberJoanComasFdz18-Sep-07 1:16 
QuestionExample Pin
fitchwh2-Apr-07 18:01
Memberfitchwh2-Apr-07 18:01 
GeneralHighlighting Text Pin
subduction365-Jan-07 23:05
Membersubduction365-Jan-07 23:05 
GeneralRegardinmg Win32 List box vertical scroll pos issue Pin
mohsin_m26-Dec-06 19:57
Membermohsin_m26-Dec-06 19:57 
AnswerRe: Regardinmg Win32 List box vertical scroll pos issue Pin
Uri Guy26-Dec-06 21:12
MemberUri Guy26-Dec-06 21:12 
GeneralGreat Article Pin
ganesan balachandar20-Dec-06 4:32
Memberganesan balachandar20-Dec-06 4:32 
GeneralBold keyword Pin
sars17-Dec-06 22:58
Membersars17-Dec-06 22:58 
GeneralRe: Bold keyword Pin
Dulabai5-Feb-07 3:44
MemberDulabai5-Feb-07 3:44 
GeneralRe: Bold keyword Pin
kabwla25-Nov-07 20:15
Memberkabwla25-Nov-07 20:15 
GeneralRe: Bold keyword Pin
MarcinJXXXX17-Apr-15 23:03
MemberMarcinJXXXX17-Apr-15 23:03 
GeneralCode could not be downloaded!!! Pin
ganesan balachandar17-Dec-06 20:21
Memberganesan balachandar17-Dec-06 20:21 
Generalthanx Pin
muslima_me15-Dec-06 15:10
Membermuslima_me15-Dec-06 15:10 
GeneralUnsafe code Pin
Omi -- Tola7-Dec-06 8:24
MemberOmi -- Tola7-Dec-06 8:24 

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.