Click here to Skip to main content
12,406,098 members (37,118 online)
Click here to Skip to main content
Add your own
alternative version

Stats

317.8K views
9.5K downloads
211 bookmarked
Posted

RichTextBoxExtended

, 21 Jun 2006
Rate this:
Please Sign up or sign in to vote.
A RichTextBox with a richtext toolbar.

RichTextBoxExtended ScreenShot

Introduction

Hello again, my friends. Today's control is a very simple yet useful control. It is a custom control that contains both a RichTextBox and a Toolbar. Now you might ask: "Why is that so important and useful?" It's because I have taken the liberty to do some coding for you. The toolbar not only looks pretty but it's functional too. It contains some of the everyday, plain, and simple things you want your users to be able to do when they input text.

Background

[Cheesy flashback music and graphics.] It all started when I was trying to remember how to insert a rich text "stamp" into a RichTextBox. Along the road to remembering, I thought to myself "Self, wouldn't it be easier not to have to remember this stuff every 6 months?" My answer was a big yes. It would be easier if I just built a control to use every time I needed users to input text. Then thinking of all the wonderful and helpful people on The Code Project, I decided to distribute my control so that everyone can learn how to do this stuff and also so they will have a pre-built control for use whenever they want.

Using the control

There are two ways you can use this control. You can either add the RichTextBoxExtended.cs file to your project and use the control by setting it up in code, or you can add the control to your toolbar and drag it on to your Form. One other thing, if you add the .cs file to your project, you will also have to add an ImageList to your project that contains all the images for the Toolbar. I prefer (and suggest) the latter method because I get to see the control on the form and I don't have to create the ImageList on every form I want to use this control on.

There are several properties that will help you use this control, and they are listed below:

  • AcceptsTab
  • AutoWordSelection
  • ReadOnly
  • ShowBold
  • ShowCenterJustify
  • ShowColors
  • ShowCopy
  • ShowCut
  • ShowFont
  • ShowFontSize
  • ShowItalic
  • ShowLeftJustify
  • ShowOpen
  • ShowPaste
  • ShowRedo
  • ShowRightJustify
  • ShowSave
  • ShowStamp
  • ShowStrikeout
  • ShowUnderline
  • ShowUndo
  • StampColor
  • StampAction
  • Toolbar - only use at runtime, changes that are made at design time will not persist.
  • RichTextBox - only use at runtime, changes that are made at design time will not persist.

Out of all of these, most of them are simply turning features on and off. The only really special ones are StampColor, StampAction, Toolbar, and RichTextBox.

  • StampColor is what it sounds like. It is the color the text will be in when a stamp is added to the RichTextBox.
  • StampAction can be one of three values: EditedBy, DateTime, or Custom.
  • EditBy is a string that reads "Edited by " + CurrentPrincipal.Identity.Name + " (theUserName) on " + DateTime.Now.ToLongDateString().
  • DateTime: DateTime.Now.ToLongDateString().
  • Custom: For Custom, you must handle the stamp event of this control.
private void richTextBoxExtended1_Stamp(object sender, System.EventArgs e)
{
    //holds our stamp text
    StringBuilder stamp = new StringBuilder("");
    if(richTextBoxExtended1.RichTextBox.Text.Length > 0)
      stamp.Append("\r\n\r\n"); //add two lines for space
    stamp.Append("Custom stamp goes here!\r\n");

    //unselect everything basicly
    richTextBoxExtended1.RichTextBox.SelectionLength = 0;
    richTextBoxExtended1.RichTextBox.SelectionStart =
       richTextBoxExtended1.RichTextBox.Text.Length;
       //start new selection at the end of the text

    richTextBoxExtended1.RichTextBox.SelectionColor
      = richTextBoxExtended1.StampColor;
      //make the selection blue
    richTextBoxExtended1.RichTextBox.SelectionFont =
      new Font(richTextBoxExtended1.RichTextBox.SelectionFont,
      FontStyle.Bold); //set the selection font and style
    richTextBoxExtended1.RichTextBox.AppendText(stamp.ToString());
    //add the stamp to the richtextbox

    richTextBoxExtended1.RichTextBox.Focus();
    //set focus back on the richtextbox
}

Points of Interest

The biggest point of interest after all these months now is the amount of feedback, interest, and work one little control can bring to your life. I haven't been able to maintain this code like I wanted but thanks to all that have helped and made suggestions along the way. Along with this updated article comes news of RichTextBoxExtended for Framework 2.0. So if you want all these features in VS 2005 then keep watching. Anyone wanting to help, just email me.

OK, so what did I learn from this control and this experience? I learned about Exclusive-OR. This is a really handy operation that saved me 100 or so lines of code in this control. In the code below, the OR is the "^". The best way I can explain it is, it takes two values like 00000001 and 00000010 and compares them. In the example below, it checks the style and if the style = 00000001, it will change it to 00000000, however if it is 00000000, then it will change it to 00000001. That isn't the best explanation of this operation, so below the code are some links for you.

rtb1.SelectionFont = new Font(rtb1.SelectionFont,
              rtb1.SelectionFont.Style ^ FontStyle.Bold);

History

  • 1.0 - Initial release - 1/31/2004.
  • 1.1 - 4/18/2005.
    • Font Selector added.
    • Font Size Selector added.
    • Fixed error that caused the control to crash when two or more font types were selected.
    • Cleaned up the code.
  • 1.2 - 12/12/2005
    • Fixed multiple font selection bug. You can now add font styles (e.g. Bold and Color) when selecting two different fonts at the same time.
    • Added a selection change event named SelChanged.
    • Added cut, copy and paste buttons.
    • The control now uses the ToolBarButton.Tag property instead of the ToolBarButton.ToolTip property for button presses. Now you can have your tooltips be whatever you like.
    • Added DetectUrls property. You can have HTTP links in your RichTextBox and click them to open the system default browser.
    • Added a ReadOnly property.
    • Added AcceptsTabs property.
    • Added AutoWordSelection property.
    • Added keyboard handler for Ctrl+B, Ctrl+I, Ctrl+S, Ctrl+U, Ctrl+-.
    • The download now comes with all the images. I also included a print image.
    • Cleaned up the code.

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

Richard Parsons
Web Developer
United States United States
Richard is a contract developer that currently lives in Arkansas. He has spent most of his career working in healthcare related companies. On his first job he was programming asp using VBScript and his boss walked in and told the whole group to get in their cars and drive to Barnes and Nobles. Once there he let everyone buy a few books about .NET and then he dropped the bomb, he said we would no longer write asp code. Starting Monday we were to be .NET developers.

Five years later Richard is a competent and self motivated .NET developer that can tackle most any problem. He has recently started his own business BellaDev which is proving to be a fun and challenging opportunity.

You may also be interested in...

Comments and Discussions

 
GeneralMy vote of 5 Pin
Member 1172797129-May-15 2:32
memberMember 1172797129-May-15 2:32 
QuestionGood! Pin
Marco Bahamondes28-Aug-14 5:57
memberMarco Bahamondes28-Aug-14 5:57 
QuestionAdd Table Pin
loserkidz3213-Nov-13 23:27
memberloserkidz3213-Nov-13 23:27 
QuestionLicense Pin
Member 1033556915-Oct-13 2:33
memberMember 1033556915-Oct-13 2:33 
QuestionSo powerfull control, but I have small problem with it Pin
yasser hosny20-Dec-12 1:42
memberyasser hosny20-Dec-12 1:42 
Questioncould i use it for some project to make money Pin
xuping1111029-Nov-12 22:37
memberxuping1111029-Nov-12 22:37 
GeneralMy vote of 1 Pin
Igor9515-Nov-12 17:27
memberIgor9515-Nov-12 17:27 
GeneralMy vote of 5 Pin
pcs041425-Oct-12 4:11
memberpcs041425-Oct-12 4:11 
QuestionI don't know why I can't use f.RichTextBoxEx1.rtb.rtf Pin
Cup of Coffee25-Apr-12 11:44
memberCup of Coffee25-Apr-12 11:44 
AnswerRe: I don't know why I can't use f.RichTextBoxEx1.rtb.rtf Pin
Stijn Courtheyn9-Dec-12 2:49
memberStijn Courtheyn9-Dec-12 2:49 
GeneralThanks Pin
si2480319-Oct-10 6:02
membersi2480319-Oct-10 6:02 
QuestionHow to retrieve richtext from MySql and display on form Pin
Elikhater14-Apr-10 20:26
memberElikhater14-Apr-10 20:26 
GeneralGreat control Pin
schuetzem7812-Apr-10 10:15
memberschuetzem7812-Apr-10 10:15 
GeneralThanks alot! Pin
Delfy_Coltech28-Oct-09 15:33
memberDelfy_Coltech28-Oct-09 15:33 
GeneralUsing GDI+ to print RTF texts Pin
romias24-Sep-09 7:33
memberromias24-Sep-09 7:33 
Questionhow to use whit a databse Pin
faramendi26-Aug-09 5:49
memberfaramendi26-Aug-09 5:49 
AnswerRe: how to use whit a databse Pin
romias24-Sep-09 7:26
memberromias24-Sep-09 7:26 
Questionhow to use whit a databse Pin
faramendi26-Aug-09 5:48
memberfaramendi26-Aug-09 5:48 
QuestionLicense? Pin
PhilDeets3-Aug-09 10:27
memberPhilDeets3-Aug-09 10:27 
GeneralTool tip text Pin
Member 269378016-Feb-09 22:10
memberMember 269378016-Feb-09 22:10 
GeneralRe: Tool tip text Pin
Member 269378016-Feb-09 22:15
memberMember 269378016-Feb-09 22:15 
GeneralMinor improvements Pin
mb1826-Sep-08 5:35
membermb1826-Sep-08 5:35 
GeneralBug in paste operation with .Net 2.0 Pin
chk_at9-Apr-08 0:05
memberchk_at9-Apr-08 0:05 
GeneralSetting margins based on RTF Margin Size Pin
mgladding13-Nov-07 10:36
membermgladding13-Nov-07 10:36 
GeneralRe: Setting margins based on RTF Margin Size Pin
SKiLLa26-Mar-08 5:55
memberSKiLLa26-Mar-08 5:55 

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.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.160726.1 | Last Updated 21 Jun 2006
Article Copyright 2005 by Richard Parsons
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid