Dsguy
asked on
User Interface For File Compare
I am looking for some direction on creating a user interface similar to the one used in SQL Compare and some file compare programs. I am most interested in the bottom portion which shows the contents of one file on the right and the other file on the left, in between there is an icon indicating new removed or changed. The other feature is that when you scroll the one side it automatically scrolls the other side. I am looking to do this in either VB.net or C#. Can someone point me in the right direction on how to go about creating something like this or point me to a source code example.
ASKER
That was one way I was thinking of but then I have the issue of making them scroll together along with the images that I wish to put in between the 2 text boxes.
Extended RichTextBox control in VB.NET to synchronize the scroll positions:
Public Class RichTextBoxEx : Inherits System.Windows.Forms.RichT
#Region " Windows Form Designer generated code "
Public Sub New()
MyBase.New()
'This call is required by the Windows Form Designer.
InitializeComponent()
'Add any initialization after the InitializeComponent() call
End Sub
'UserControl overrides dispose to clean up the component list.
Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
If disposing Then
If Not (components Is Nothing) Then
components.Dispose()
End If
End If
MyBase.Dispose(disposing)
End Sub
'Required by the Windows Form Designer
Private components As System.ComponentModel.ICon
'NOTE: The following procedure is required by the Windows Form Designer
'It can be modified using the Windows Form Designer.
'Do not modify it using the code editor.
<System.Diagnostics.Debugg
components = New System.ComponentModel.Cont
End Sub
#End Region
Public Class RichTextBoxArgs : Inherits EventArgs
Public Position As Integer
Public Sub New(ByVal newPosition As Integer)
Me.Position = newPosition
End Sub
End Class
' Horizontal scroll.
Private Const WM_HSCROLL As Integer = &H114
' Vertical scroll.
Private Const WM_VSCROLL As Integer = &H115
Private Const SB_THUMBPOSITION As Integer = &H4
Private Const SBS_HORZ As Integer = &H0
Private Const SBS_VERT As Integer = &H1
' Notify caller that a scroll has occurred.
Public Shadows Event HScroll(ByVal sender As Object, ByVal e As RichTextBoxArgs)
Public Shadows Event VScroll(ByVal sender As Object, ByVal e As RichTextBoxArgs)
' Get the scroll position of horizontal/vertical scroll bar.
Private Declare Function GetScrollPos Lib "user32" _
(ByVal handle As IntPtr, ByVal nBar As Integer) As Integer
' Send a scroll message to the horizontal/vertical scroll bar.
Private Declare Function PostMessage Lib "user32.dll" Alias "PostMessageA" _
(ByVal hwnd As IntPtr, ByVal wMsg As Integer, _
ByVal wParam As Integer, ByVal lParam As Integer) As Boolean
Public Sub SetHorizontalScrollPositio
PostMessage(Me.Handle, WM_HSCROLL, SB_THUMBPOSITION + &H10000 * newPosition, 0)
End Sub 'SetHorizontalScrollPositi
Public Sub SetVerticalScrollPosition(
PostMessage(Me.Handle, WM_VSCROLL, SB_THUMBPOSITION + &H10000 * newPosition, 0)
End Sub 'SetVerticalScrollPosition
Protected Overrides Sub WndProc(ByRef m As System.Windows.Forms.Messa
' Sub-class the RichTextBox user control to detect horizontal/vertical
' scrolling.
Dim currentPosition As Integer
Select Case m.Msg
' Vertical scroll.
Case WM_VSCROLL
currentPosition = GetScrollPos(Me.Handle, SBS_VERT)
RaiseEvent VScroll(Me, New RichTextBoxArgs(currentPos
' Horizontal scroll.
Case WM_HSCROLL
currentPosition = GetScrollPos(Me.Handle, SBS_HORZ)
RaiseEvent HScroll(Me, New RichTextBoxArgs(currentPos
End Select
MyBase.WndProc(m)
End Sub 'WndProc'
End Class
Usage:
Private Sub RichTextBoxEx1_VScroll(ByV
Me.RichTextBoxEx2.SetVerti
End Sub
Bob
Public Class RichTextBoxEx : Inherits System.Windows.Forms.RichT
#Region " Windows Form Designer generated code "
Public Sub New()
MyBase.New()
'This call is required by the Windows Form Designer.
InitializeComponent()
'Add any initialization after the InitializeComponent() call
End Sub
'UserControl overrides dispose to clean up the component list.
Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
If disposing Then
If Not (components Is Nothing) Then
components.Dispose()
End If
End If
MyBase.Dispose(disposing)
End Sub
'Required by the Windows Form Designer
Private components As System.ComponentModel.ICon
'NOTE: The following procedure is required by the Windows Form Designer
'It can be modified using the Windows Form Designer.
'Do not modify it using the code editor.
<System.Diagnostics.Debugg
components = New System.ComponentModel.Cont
End Sub
#End Region
Public Class RichTextBoxArgs : Inherits EventArgs
Public Position As Integer
Public Sub New(ByVal newPosition As Integer)
Me.Position = newPosition
End Sub
End Class
' Horizontal scroll.
Private Const WM_HSCROLL As Integer = &H114
' Vertical scroll.
Private Const WM_VSCROLL As Integer = &H115
Private Const SB_THUMBPOSITION As Integer = &H4
Private Const SBS_HORZ As Integer = &H0
Private Const SBS_VERT As Integer = &H1
' Notify caller that a scroll has occurred.
Public Shadows Event HScroll(ByVal sender As Object, ByVal e As RichTextBoxArgs)
Public Shadows Event VScroll(ByVal sender As Object, ByVal e As RichTextBoxArgs)
' Get the scroll position of horizontal/vertical scroll bar.
Private Declare Function GetScrollPos Lib "user32" _
(ByVal handle As IntPtr, ByVal nBar As Integer) As Integer
' Send a scroll message to the horizontal/vertical scroll bar.
Private Declare Function PostMessage Lib "user32.dll" Alias "PostMessageA" _
(ByVal hwnd As IntPtr, ByVal wMsg As Integer, _
ByVal wParam As Integer, ByVal lParam As Integer) As Boolean
Public Sub SetHorizontalScrollPositio
PostMessage(Me.Handle, WM_HSCROLL, SB_THUMBPOSITION + &H10000 * newPosition, 0)
End Sub 'SetHorizontalScrollPositi
Public Sub SetVerticalScrollPosition(
PostMessage(Me.Handle, WM_VSCROLL, SB_THUMBPOSITION + &H10000 * newPosition, 0)
End Sub 'SetVerticalScrollPosition
Protected Overrides Sub WndProc(ByRef m As System.Windows.Forms.Messa
' Sub-class the RichTextBox user control to detect horizontal/vertical
' scrolling.
Dim currentPosition As Integer
Select Case m.Msg
' Vertical scroll.
Case WM_VSCROLL
currentPosition = GetScrollPos(Me.Handle, SBS_VERT)
RaiseEvent VScroll(Me, New RichTextBoxArgs(currentPos
' Horizontal scroll.
Case WM_HSCROLL
currentPosition = GetScrollPos(Me.Handle, SBS_HORZ)
RaiseEvent HScroll(Me, New RichTextBoxArgs(currentPos
End Select
MyBase.WndProc(m)
End Sub 'WndProc'
End Class
Usage:
Private Sub RichTextBoxEx1_VScroll(ByV
Me.RichTextBoxEx2.SetVerti
End Sub
Bob
Code updated.
Bob
Bob
ASKER
Bob,
This kind of works. I need it to scroll both textboxes as I drag the scrollbar up and down. This one doesn't refresh until mouse up. I am new to dealing with API calls and not sure how to fix this. Any ideas.
This kind of works. I need it to scroll both textboxes as I drag the scrollbar up and down. This one doesn't refresh until mouse up. I am new to dealing with API calls and not sure how to fix this. Any ideas.
ASKER
I have found this class that does exactly what I need for syncing. You create an instance of the class and then add the rich textboxes that you wish to sync.
' This class is used to tie multiple rich textboxes together and have them scroll in sync
' Use:
' Define an instance of the class
' Private objScrollSync As New RichTextBoxScrollSync
'
' Specify which scrollbars to sync
' objScrollSync.ScrollBarToS
'
' add the textboxes you wish to sync
' objScrollSync.AddControl(R
' objScrollSync.AddControl(R
'
Imports System.Runtime.InteropServ
Imports System.Windows.Forms
Public Class RichTextBoxScrollSync
#Region "Declare Win32 API Calls"
Private Declare Auto Function SendScrollPosMessage Lib "user32.dll" Alias "SendMessage" ( _
ByVal hWnd As IntPtr, _
ByVal Msg As Integer, _
ByVal wParam As IntPtr, _
ByRef lParam As POINT) As Integer
#End Region
#Region "Constants"
Private Const WM_USER = &H400
Private Const EM_GETSCROLLPOS = WM_USER + 221
Private Const EM_SETSCROLLPOS = WM_USER + 222
#End Region
#Region "Structures"
Private Structure POINT
Public x As Integer
Public y As Integer
End Structure
#End Region
#Region "Properties"
Private aControls As New ArrayList
Private sbScrollBarType As Windows.Forms.ScrollBars
Public Property ScrollBarToSync() As Windows.Forms.ScrollBars
Get
Return sbScrollBarType
End Get
Set(ByVal Value As Windows.Forms.ScrollBars)
sbScrollBarType = Value
End Set
End Property
#End Region
#Region "Public Methods"
Public Sub AddControl(ByVal RTFControl As Object)
Dim objControlSubClass As New clsWindowSubClass(RTFContr
aControls.Add(objControlSu
End Sub
Public Sub SyncScrollBars(ByVal Handle As IntPtr, _
ByVal SubClass As clsWindowSubClass, _
ByVal Window As Object, _
ByRef WindowsMessage As Message)
Static blnIgnoreMessages As Boolean
If blnIgnoreMessages = True Then Exit Sub
blnIgnoreMessages = True
Dim blnChangeVertPos As Boolean = False
Dim blnChangeHorizPos As Boolean = False
Dim lngVertPos, lngHorizPos As Long
Dim stcScrollPoint As New POINT
Dim ptrScrollPoint As IntPtr
SendScrollPosMessage(Handl
lngVertPos = stcScrollPoint.y
lngHorizPos = stcScrollPoint.x
If (sbScrollBarType = RichTextBoxScrollBars.Both
sbScrollBarType = RichTextBoxScrollBars.Vert
If (sbScrollBarType = RichTextBoxScrollBars.Both
sbScrollBarType = RichTextBoxScrollBars.Hori
If blnChangeVertPos = True Or blnChangeHorizPos = True Then
Dim objSubClass As clsWindowSubClass
Dim objWindowMessage As New Windows.Forms.Message
For Each objSubClass In aControls
If objSubClass.Handle.ToInt32
SendScrollPosMessage(objSu
If blnChangeHorizPos = True Then stcScrollPoint.x = lngHorizPos
If blnChangeVertPos = True Then stcScrollPoint.y = lngVertPos
SendScrollPosMessage(objSu
End If
Next
End If
blnIgnoreMessages = False
End Sub
#End Region
End Class
Public Class clsWindowSubClass
Inherits System.Windows.Forms.Nativ
Private objWindow As Object
Private objParent As RichTextBoxScrollSync
Public Sub New(ByVal Handle As IntPtr, ByVal Window As Object, ByVal Parent As RichTextBoxScrollSync)
objWindow = Window
objParent = Parent
MyBase.AssignHandle(Handle
End Sub
Protected Overrides Sub WndProc(ByRef WindowMessage As System.Windows.Forms.Messa
MyBase.WndProc(WindowMessa
objParent.SyncScrollBars(M
End Sub
End Class
' This class is used to tie multiple rich textboxes together and have them scroll in sync
' Use:
' Define an instance of the class
' Private objScrollSync As New RichTextBoxScrollSync
'
' Specify which scrollbars to sync
' objScrollSync.ScrollBarToS
'
' add the textboxes you wish to sync
' objScrollSync.AddControl(R
' objScrollSync.AddControl(R
'
Imports System.Runtime.InteropServ
Imports System.Windows.Forms
Public Class RichTextBoxScrollSync
#Region "Declare Win32 API Calls"
Private Declare Auto Function SendScrollPosMessage Lib "user32.dll" Alias "SendMessage" ( _
ByVal hWnd As IntPtr, _
ByVal Msg As Integer, _
ByVal wParam As IntPtr, _
ByRef lParam As POINT) As Integer
#End Region
#Region "Constants"
Private Const WM_USER = &H400
Private Const EM_GETSCROLLPOS = WM_USER + 221
Private Const EM_SETSCROLLPOS = WM_USER + 222
#End Region
#Region "Structures"
Private Structure POINT
Public x As Integer
Public y As Integer
End Structure
#End Region
#Region "Properties"
Private aControls As New ArrayList
Private sbScrollBarType As Windows.Forms.ScrollBars
Public Property ScrollBarToSync() As Windows.Forms.ScrollBars
Get
Return sbScrollBarType
End Get
Set(ByVal Value As Windows.Forms.ScrollBars)
sbScrollBarType = Value
End Set
End Property
#End Region
#Region "Public Methods"
Public Sub AddControl(ByVal RTFControl As Object)
Dim objControlSubClass As New clsWindowSubClass(RTFContr
aControls.Add(objControlSu
End Sub
Public Sub SyncScrollBars(ByVal Handle As IntPtr, _
ByVal SubClass As clsWindowSubClass, _
ByVal Window As Object, _
ByRef WindowsMessage As Message)
Static blnIgnoreMessages As Boolean
If blnIgnoreMessages = True Then Exit Sub
blnIgnoreMessages = True
Dim blnChangeVertPos As Boolean = False
Dim blnChangeHorizPos As Boolean = False
Dim lngVertPos, lngHorizPos As Long
Dim stcScrollPoint As New POINT
Dim ptrScrollPoint As IntPtr
SendScrollPosMessage(Handl
lngVertPos = stcScrollPoint.y
lngHorizPos = stcScrollPoint.x
If (sbScrollBarType = RichTextBoxScrollBars.Both
sbScrollBarType = RichTextBoxScrollBars.Vert
If (sbScrollBarType = RichTextBoxScrollBars.Both
sbScrollBarType = RichTextBoxScrollBars.Hori
If blnChangeVertPos = True Or blnChangeHorizPos = True Then
Dim objSubClass As clsWindowSubClass
Dim objWindowMessage As New Windows.Forms.Message
For Each objSubClass In aControls
If objSubClass.Handle.ToInt32
SendScrollPosMessage(objSu
If blnChangeHorizPos = True Then stcScrollPoint.x = lngHorizPos
If blnChangeVertPos = True Then stcScrollPoint.y = lngVertPos
SendScrollPosMessage(objSu
End If
Next
End If
blnIgnoreMessages = False
End Sub
#End Region
End Class
Public Class clsWindowSubClass
Inherits System.Windows.Forms.Nativ
Private objWindow As Object
Private objParent As RichTextBoxScrollSync
Public Sub New(ByVal Handle As IntPtr, ByVal Window As Object, ByVal Parent As RichTextBoxScrollSync)
objWindow = Window
objParent = Parent
MyBase.AssignHandle(Handle
End Sub
Protected Overrides Sub WndProc(ByRef WindowMessage As System.Windows.Forms.Messa
MyBase.WndProc(WindowMessa
objParent.SyncScrollBars(M
End Sub
End Class
ASKER
I also found a extended rich textbox class that easily lets you set the backcolor.
using System;
using System.Collections.Special
using System.Drawing;
using System.Drawing.Imaging;
using System.IO;
using System.Runtime.InteropServ
using System.Text;
using System.Windows.Forms;
namespace DataShapers.Controls {
#region Public Enums
// Enum for possible RTF colors
public enum RtfColor {
Black, Maroon, Green, Olive, Navy, Purple, Teal, Gray, Silver,
Red, Lime, Yellow, Blue, Fuchsia, Aqua, White, LightGreen
}
#endregion
/// <summary>
/// This class adds the following functionality to RichTextBox:
///
/// 1. Allows plain text to be inserted or appended programmatically to RTF
/// content.
/// 2. Allows the font, text color, and highlight color of plain text to be
/// specified when inserting or appending text as RTF.
/// 3. Allows images to be inserted programmatically, or with interaction from
/// the user.
/// </summary>
/// <remarks>
/// Many solutions to the problem of programmatically inserting images
/// into a RichTextBox use the clipboard or hard code the RTF for
/// the image in the program. This class is an attempt to make the process of
/// inserting images at runtime more flexible without the overhead of maintaining
/// the clipboard or the use of huge, cumbersome strings.
///
/// RTF Specification v1.6 was used and is referred to many times in this document.
/// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnrtfspec/html/rtfspec.asp
///
/// For information about the RichEdit (Unmanaged RichTextBox) ...
/// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/commctls/richedit/richeditcontrols/aboutricheditcontrols.asp
/// </remarks>
public class ExRichTextBox : System.Windows.Forms.RichT
#region My Enums
// Specifies the flags/options for the unmanaged call to the GDI+ method
// Metafile.EmfToWmfBits().
private enum EmfToWmfBitsFlags
{
// Use the default conversion
EmfToWmfBitsFlagsDefault = 0x00000000,
// Embedded the source of the EMF metafiel within the resulting WMF
// metafile
EmfToWmfBitsFlagsEmbedEmf = 0x00000001,
// Place a 22-byte header in the resulting WMF file. The header is
// required for the metafile to be considered placeable.
EmfToWmfBitsFlagsIncludePl
// Don't simulate clipping by using the XOR operator.
EmfToWmfBitsFlagsNoXORClip
};
#endregion
#region My Structs
// Definitions for colors in an RTF document
private struct RtfColorDef {
public const string Black = @"\red0\green0\blue0";
public const string Maroon = @"\red128\green0\blue0";
public const string Green = @"\red0\green128\blue0";
public const string Olive = @"\red128\green128\blue0";
public const string Navy = @"\red0\green0\blue128";
public const string Purple = @"\red128\green0\blue128";
public const string Teal = @"\red0\green128\blue128";
public const string Gray = @"\red128\green128\blue128
public const string Silver = @"\red192\green192\blue192
public const string Red = @"\red255\green0\blue0";
public const string Lime = @"\red0\green255\blue0";
public const string Yellow = @"\red255\green255\blue0";
public const string Blue = @"\red0\green0\blue255";
public const string Fuchsia = @"\red255\green0\blue255";
public const string Aqua = @"\red0\green255\blue255";
public const string White = @"\red255\green255\blue255
public const string LightGreen = @"\red128\green255\blue128
}
// Control words for RTF font families
private struct RtfFontFamilyDef {
public const string Unknown = @"\fnil";
public const string Roman = @"\froman";
public const string Swiss = @"\fswiss";
public const string Modern = @"\fmodern";
public const string Script = @"\fscript";
public const string Decor = @"\fdecor";
public const string Technical = @"\ftech";
public const string BiDirect = @"\fbidi";
}
#endregion
#region My Constants
// Not used in this application. Descriptions can be found with documentation
// of Windows GDI function SetMapMode
private const int MM_TEXT = 1;
private const int MM_LOMETRIC = 2;
private const int MM_HIMETRIC = 3;
private const int MM_LOENGLISH = 4;
private const int MM_HIENGLISH = 5;
private const int MM_TWIPS = 6;
// Ensures that the metafile maintains a 1:1 aspect ratio
private const int MM_ISOTROPIC = 7;
// Allows the x-coordinates and y-coordinates of the metafile to be adjusted
// independently
private const int MM_ANISOTROPIC = 8;
// Represents an unknown font family
private const string FF_UNKNOWN = "UNKNOWN";
// The number of hundredths of millimeters (0.01 mm) in an inch
// For more information, see GetImagePrefix() method.
private const int HMM_PER_INCH = 2540;
// The number of twips in an inch
// For more information, see GetImagePrefix() method.
private const int TWIPS_PER_INCH = 1440;
#endregion
#region My Privates
// The default text color
private RtfColor textColor;
// The default text background color
private RtfColor highlightColor;
// Dictionary that maps color enums to RTF color codes
private HybridDictionary rtfColor;
// Dictionary that mapas Framework font families to RTF font families
private HybridDictionary rtfFontFamily;
// The horizontal resolution at which the control is being displayed
private float xDpi;
// The vertical resolution at which the control is being displayed
private float yDpi;
#endregion
#region Elements required to create an RTF document
/* RTF HEADER
* ----------
*
* \rtf[N] - For text to be considered to be RTF, it must be enclosed in this tag.
* rtf1 is used because the RichTextBox conforms to RTF Specification
* version 1.
* \ansi - The character set.
* \ansicpg[N] - Specifies that unicode characters might be embedded. ansicpg1252
* is the default used by Windows.
* \deff[N] - The default font. \deff0 means the default font is the first font
* found.
* \deflang[N] - The default language. \deflang1033 specifies US English.
* */
private const string RTF_HEADER = @"{\rtf1\ansi\ansicpg1252\
/* RTF DOCUMENT AREA
* -----------------
*
* \viewkind[N] - The type of view or zoom level. \viewkind4 specifies normal view.
* \uc[N] - The number of bytes corresponding to a Unicode character.
* \pard - Resets to default paragraph properties
* \cf[N] - Foreground color. \cf1 refers to the color at index 1 in
* the color table
* \f[N] - Font number. \f0 refers to the font at index 0 in the font
* table.
* \fs[N] - Font size in half-points.
* */
private const string RTF_DOCUMENT_PRE = @"\viewkind4\uc1\pard\cf1\
private const string RTF_DOCUMENT_POST = @"\cf0\fs17}";
private string RTF_IMAGE_POST = @"}";
#endregion
#region Accessors
// TODO: This can be ommitted along with RemoveBadCharacters
// Overrides the default implementation of RTF. This is done because the control
// was originally developed to run in an instant messenger that uses the
// Jabber XML-based protocol. The framework would throw an exception when the
// XML contained the null character, so I filtered out.
public new string Rtf {
get {return RemoveBadChars(base.Rtf);}
set {base.Rtf = value;}
}
// The color of the text
public RtfColor TextColor {
get {return textColor;}
set {textColor = value;}
}
// The color of the highlight
public RtfColor HiglightColor {
get {return highlightColor;}
set {highlightColor = value;}
}
#endregion
#region Constructors
/// <summary>
/// Initializes the text colors, creates dictionaries for RTF colors and
/// font families, and stores the horizontal and vertical resolution of
/// the RichTextBox's graphics context.
/// </summary>
public ExRichTextBox() : base() {
// Initialize default text and background colors
textColor = RtfColor.Black;
highlightColor = RtfColor.White;
// Initialize the dictionary mapping color codes to definitions
rtfColor = new HybridDictionary();
rtfColor.Add(RtfColor.Aqua
rtfColor.Add(RtfColor.Blac
rtfColor.Add(RtfColor.Blue
rtfColor.Add(RtfColor.Fuch
rtfColor.Add(RtfColor.Gray
rtfColor.Add(RtfColor.Gree
rtfColor.Add(RtfColor.Ligh
rtfColor.Add(RtfColor.Lime
rtfColor.Add(RtfColor.Maro
rtfColor.Add(RtfColor.Navy
rtfColor.Add(RtfColor.Oliv
rtfColor.Add(RtfColor.Purp
rtfColor.Add(RtfColor.Red,
rtfColor.Add(RtfColor.Silv
rtfColor.Add(RtfColor.Teal
rtfColor.Add(RtfColor.Whit
rtfColor.Add(RtfColor.Yell
// Initialize the dictionary mapping default Framework font families to
// RTF font families
rtfFontFamily = new HybridDictionary();
rtfFontFamily.Add(FontFami
rtfFontFamily.Add(FontFami
rtfFontFamily.Add(FontFami
rtfFontFamily.Add(FF_UNKNO
// Get the horizontal and vertical resolutions at which the object is
// being displayed
using(Graphics _graphics = this.CreateGraphics()) {
xDpi = _graphics.DpiX;
yDpi = _graphics.DpiY;
}
}
/// <summary>
/// Calls the default constructor then sets the text color.
/// </summary>
/// <param name="_textColor"></param>
public ExRichTextBox(RtfColor _textColor) : this() {
textColor = _textColor;
}
/// <summary>
/// Calls the default constructor then sets te text and highlight colors.
/// </summary>
/// <param name="_textColor"></param>
/// <param name="_highlightColor"></p
public ExRichTextBox(RtfColor _textColor, RtfColor _highlightColor) : this() {
textColor = _textColor;
highlightColor = _highlightColor;
}
#endregion
#region Append RTF or Text to RichTextBox Contents
/// <summary>
/// Assumes the string passed as a paramter is valid RTF text and attempts
/// to append it as RTF to the content of the control.
/// </summary>
/// <param name="_rtf"></param>
public void AppendRtf(string _rtf) {
// Move caret to the end of the text
this.Select(this.TextLengt
// Since SelectedRtf is null, this will append the string to the
// end of the existing RTF
this.SelectedRtf = _rtf;
}
/// <summary>
/// Assumes that the string passed as a parameter is valid RTF text and
/// attempts to insert it as RTF into the content of the control.
/// </summary>
/// <remarks>
/// NOTE: The text is inserted wherever the caret is at the time of the call,
/// and if any text is selected, that text is replaced.
/// </remarks>
/// <param name="_rtf"></param>
public void InsertRtf(string _rtf) {
this.SelectedRtf = _rtf;
}
/// <summary>
/// Appends the text using the current font, text, and highlight colors.
/// </summary>
/// <param name="_text"></param>
public void AppendTextAsRtf(string _text) {
AppendTextAsRtf(_text, this.Font);
}
/// <summary>
/// Appends the text using the given font, and current text and highlight
/// colors.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
public void AppendTextAsRtf(string _text, Font _font) {
AppendTextAsRtf(_text, _font, textColor);
}
/// <summary>
/// Appends the text using the given font and text color, and the current
/// highlight color.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_color"></param>
public void AppendTextAsRtf(string _text, Font _font, RtfColor _textColor) {
AppendTextAsRtf(_text, _font, _textColor, highlightColor);
}
/// <summary>
/// Appends the text using the given font, text, and highlight colors. Simply
/// moves the caret to the end of the RichTextBox's text and makes a call to
/// insert.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_textColor"></param>
/// <param name="_backColor"></param>
public void AppendTextAsRtf(string _text, Font _font, RtfColor _textColor, RtfColor _backColor) {
// Move carret to the end of the text
this.Select(this.TextLengt
InsertTextAsRtf(_text, _font, _textColor, _backColor);
}
#endregion
#region Insert Plain Text
/// <summary>
/// Inserts the text using the current font, text, and highlight colors.
/// </summary>
/// <param name="_text"></param>
public void InsertTextAsRtf(string _text) {
InsertTextAsRtf(_text, this.Font);
}
/// <summary>
/// Inserts the text using the given font, and current text and highlight
/// colors.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
public void InsertTextAsRtf(string _text, Font _font) {
InsertTextAsRtf(_text, _font, textColor);
}
/// <summary>
/// Inserts the text using the given font and text color, and the current
/// highlight color.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_color"></param>
public void InsertTextAsRtf(string _text, Font _font, RtfColor _textColor) {
InsertTextAsRtf(_text, _font, _textColor, highlightColor);
}
/// <summary>
/// Inserts the text using the given font, text, and highlight colors. The
/// text is wrapped in RTF codes so that the specified formatting is kept.
/// You can only assign valid RTF to the RichTextBox.Rtf property, else
/// an exception is thrown. The RTF string should follow this format ...
///
/// {\rtf1\ansi\ansicpg1252\de
/// \viewkind4\uc1\pard\cf1\f0
///
/// </summary>
/// <remarks>
/// NOTE: The text is inserted wherever the caret is at the time of the call,
/// and if any text is selected, that text is replaced.
/// </remarks>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_color"></param>
/// <param name="_color"></param>
public void InsertTextAsRtf(string _text, Font _font, RtfColor _textColor, RtfColor _backColor) {
StringBuilder _rtf = new StringBuilder();
// Append the RTF header
_rtf.Append(RTF_HEADER);
// Create the font table from the font passed in and append it to the
// RTF string
_rtf.Append(GetFontTable(_
// Create the color table from the colors passed in and append it to the
// RTF string
_rtf.Append(GetColorTable(
// Create the document area from the text to be added as RTF and append
// it to the RTF string.
_rtf.Append(GetDocumentAre
this.SelectedRtf = _rtf.ToString();
}
/// <summary>
/// Creates the Document Area of the RTF being inserted. The document area
/// (in this case) consists of the text being added as RTF and all the
/// formatting specified in the Font object passed in. This should have the
/// form ...
///
/// \viewkind4\uc1\pard\cf1\f0
///
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <returns>
/// The document area as a string.
/// </returns>
private string GetDocumentArea(string _text, Font _font) {
StringBuilder _doc = new StringBuilder();
// Append the standard RTF document area control string
_doc.Append(RTF_DOCUMENT_P
// Set the highlight color (the color behind the text) to the
// third color in the color table. See GetColorTable for more details.
_doc.Append(@"\highlight2"
// If the font is bold, attach corresponding tag
if (_font.Bold)
_doc.Append(@"\b");
// If the font is italic, attach corresponding tag
if (_font.Italic)
_doc.Append(@"\i");
// If the font is strikeout, attach corresponding tag
if (_font.Strikeout)
_doc.Append(@"\strike");
// If the font is underlined, attach corresponding tag
if (_font.Underline)
_doc.Append(@"\ul");
// Set the font to the first font in the font table.
// See GetFontTable for more details.
_doc.Append(@"\f0");
// Set the size of the font. In RTF, font size is measured in
// half-points, so the font size is twice the value obtained from
// Font.SizeInPoints
_doc.Append(@"\fs");
_doc.Append((int)Math.Roun
// Apppend a space before starting actual text (for clarity)
_doc.Append(@" ");
// Append actual text, however, replace newlines with RTF \par.
// Any other special text should be handled here (e.g.) tabs, etc.
_doc.Append(_text.Replace(
// RTF isn't strict when it comes to closing control words, but what the
// heck ...
// Remove the highlight
_doc.Append(@"\highlight0"
// If font is bold, close tag
if (_font.Bold)
_doc.Append(@"\b0");
// If font is italic, close tag
if (_font.Italic)
_doc.Append(@"\i0");
// If font is strikeout, close tag
if (_font.Strikeout)
_doc.Append(@"\strike0");
// If font is underlined, cloes tag
if (_font.Underline)
_doc.Append(@"\ulnone");
// Revert back to default font and size
_doc.Append(@"\f0");
_doc.Append(@"\fs20");
// Close the document area control string
_doc.Append(RTF_DOCUMENT_P
return _doc.ToString();
}
#endregion
#region Insert Image
/// <summary>
/// Inserts an image into the RichTextBox. The image is wrapped in a Windows
/// Format Metafile, because although Microsoft discourages the use of a WMF,
/// the RichTextBox (and even MS Word), wraps an image in a WMF before inserting
/// the image into a document. The WMF is attached in HEX format (a string of
/// HEX numbers).
///
/// The RTF Specification v1.6 says that you should be able to insert bitmaps,
/// .jpegs, .gifs, .pngs, and Enhanced Metafiles (.emf) directly into an RTF
/// document without the WMF wrapper. This works fine with MS Word,
/// however, when you don't wrap images in a WMF, WordPad and
/// RichTextBoxes simply ignore them. Both use the riched20.dll or msfted.dll.
/// </summary>
/// <remarks>
/// NOTE: The image is inserted wherever the caret is at the time of the call,
/// and if any text is selected, that text is replaced.
/// </remarks>
/// <param name="_image"></param>
public void InsertImage(Image _image) {
StringBuilder _rtf = new StringBuilder();
// Append the RTF header
_rtf.Append(RTF_HEADER);
// Create the font table using the RichTextBox's current font and append
// it to the RTF string
_rtf.Append(GetFontTable(t
// Create the image control string and append it to the RTF string
_rtf.Append(GetImagePrefix
// Create the Windows Metafile and append its bytes in HEX format
_rtf.Append(GetRtfImage(_i
// Close the RTF image control string
_rtf.Append(RTF_IMAGE_POST
this.SelectedRtf = _rtf.ToString();
}
/// <summary>
/// Creates the RTF control string that describes the image being inserted.
/// This description (in this case) specifies that the image is an
/// MM_ANISOTROPIC metafile, meaning that both X and Y axes can be scaled
/// independently. The control string also gives the images current dimensions,
/// and its target dimensions, so if you want to control the size of the
/// image being inserted, this would be the place to do it. The prefix should
/// have the form ...
///
/// {\pict\wmetafile8\picw[A]\
///
/// where ...
///
/// A = current width of the metafile in hundredths of millimeters (0.01mm)
/// = Image Width in Inches * Number of (0.01mm) per inch
/// = (Image Width in Pixels / Graphics Context's Horizontal Resolution) * 2540
/// = (Image Width in Pixels / Graphics.DpiX) * 2540
///
/// B = current height of the metafile in hundredths of millimeters (0.01mm)
/// = Image Height in Inches * Number of (0.01mm) per inch
/// = (Image Height in Pixels / Graphics Context's Vertical Resolution) * 2540
/// = (Image Height in Pixels / Graphics.DpiX) * 2540
///
/// C = target width of the metafile in twips
/// = Image Width in Inches * Number of twips per inch
/// = (Image Width in Pixels / Graphics Context's Horizontal Resolution) * 1440
/// = (Image Width in Pixels / Graphics.DpiX) * 1440
///
/// D = target height of the metafile in twips
/// = Image Height in Inches * Number of twips per inch
/// = (Image Height in Pixels / Graphics Context's Horizontal Resolution) * 1440
/// = (Image Height in Pixels / Graphics.DpiX) * 1440
///
/// </summary>
/// <remarks>
/// The Graphics Context's resolution is simply the current resolution at which
/// windows is being displayed. Normally it's 96 dpi, but instead of assuming
/// I just added the code.
///
/// According to Ken Howe at pbdr.com, "Twips are screen-independent units
/// used to ensure that the placement and proportion of screen elements in
/// your screen application are the same on all display systems."
///
/// Units Used
/// ----------
/// 1 Twip = 1/20 Point
/// 1 Point = 1/72 Inch
/// 1 Twip = 1/1440 Inch
///
/// 1 Inch = 2.54 cm
/// 1 Inch = 25.4 mm
/// 1 Inch = 2540 (0.01)mm
/// </remarks>
/// <param name="_image"></param>
/// <returns></returns>
private string GetImagePrefix(Image _image) {
StringBuilder _rtf = new StringBuilder();
// Calculate the current width of the image in (0.01)mm
int picw = (int)Math.Round((_image.Wi
// Calculate the current height of the image in (0.01)mm
int pich = (int)Math.Round((_image.He
// Calculate the target width of the image in twips
int picwgoal = (int)Math.Round((_image.Wi
// Calculate the target height of the image in twips
int pichgoal = (int)Math.Round((_image.He
// Append values to RTF string
_rtf.Append(@"{\pict\wmeta
_rtf.Append(@"\picw");
_rtf.Append(picw);
_rtf.Append(@"\pich");
_rtf.Append(pich);
_rtf.Append(@"\picwgoal");
_rtf.Append(picwgoal);
_rtf.Append(@"\pichgoal");
_rtf.Append(pichgoal);
_rtf.Append(" ");
return _rtf.ToString();
}
/// <summary>
/// Use the EmfToWmfBits function in the GDI+ specification to convert a
/// Enhanced Metafile to a Windows Metafile
/// </summary>
/// <param name="_hEmf">
/// A handle to the Enhanced Metafile to be converted
/// </param>
/// <param name="_bufferSize">
/// The size of the buffer used to store the Windows Metafile bits returned
/// </param>
/// <param name="_buffer">
/// An array of bytes used to hold the Windows Metafile bits returned
/// </param>
/// <param name="_mappingMode">
/// The mapping mode of the image. This control uses MM_ANISOTROPIC.
/// </param>
/// <param name="_flags">
/// Flags used to specify the format of the Windows Metafile returned
/// </param>
[DllImportAttribute("gdipl
private static extern uint GdipEmfToWmfBits (IntPtr _hEmf, uint _bufferSize,
byte[] _buffer, int _mappingMode, EmfToWmfBitsFlags _flags);
/// <summary>
/// Wraps the image in an Enhanced Metafile by drawing the image onto the
/// graphics context, then converts the Enhanced Metafile to a Windows
/// Metafile, and finally appends the bits of the Windows Metafile in HEX
/// to a string and returns the string.
/// </summary>
/// <param name="_image"></param>
/// <returns>
/// A string containing the bits of a Windows Metafile in HEX
/// </returns>
private string GetRtfImage(Image _image) {
StringBuilder _rtf = null;
// Used to store the enhanced metafile
MemoryStream _stream = null;
// Used to create the metafile and draw the image
Graphics _graphics = null;
// The enhanced metafile
Metafile _metaFile = null;
// Handle to the device context used to create the metafile
IntPtr _hdc;
try {
_rtf = new StringBuilder();
_stream = new MemoryStream();
// Get a graphics context from the RichTextBox
using(_graphics = this.CreateGraphics()) {
// Get the device context from the graphics context
_hdc = _graphics.GetHdc();
// Create a new Enhanced Metafile from the device context
_metaFile = new Metafile(_stream, _hdc);
// Release the device context
_graphics.ReleaseHdc(_hdc)
}
// Get a graphics context from the Enhanced Metafile
using(_graphics = Graphics.FromImage(_metaFi
// Draw the image on the Enhanced Metafile
_graphics.DrawImage(_image
}
// Get the handle of the Enhanced Metafile
IntPtr _hEmf = _metaFile.GetHenhmetafile(
// A call to EmfToWmfBits with a null buffer return the size of the
// buffer need to store the WMF bits. Use this to get the buffer
// size.
uint _bufferSize = GdipEmfToWmfBits(_hEmf, 0, null, MM_ANISOTROPIC,
EmfToWmfBitsFlags.EmfToWmf
// Create an array to hold the bits
byte[] _buffer = new byte[_bufferSize];
// A call to EmfToWmfBits with a valid buffer copies the bits into the
// buffer an returns the number of bits in the WMF.
uint _convertedSize = GdipEmfToWmfBits(_hEmf, _bufferSize, _buffer, MM_ANISOTROPIC,
EmfToWmfBitsFlags.EmfToWmf
// Append the bits to the RTF string
for(int i = 0; i < _buffer.Length; ++i) {
_rtf.Append(String.Format(
}
return _rtf.ToString();
}
finally {
if(_graphics != null)
_graphics.Dispose();
if(_metaFile != null)
_metaFile.Dispose();
if(_stream != null)
_stream.Close();
}
}
#endregion
#region RTF Helpers
/// <summary>
/// Creates a font table from a font object. When an Insert or Append
/// operation is performed a font is either specified or the default font
/// is used. In any case, on any Insert or Append, only one font is used,
/// thus the font table will always contain a single font. The font table
/// should have the form ...
///
/// {\fonttbl{\f0\[FAMILY]\fch
/// </summary>
/// <param name="_font"></param>
/// <returns></returns>
private string GetFontTable(Font _font) {
StringBuilder _fontTable = new StringBuilder();
// Append table control string
_fontTable.Append(@"{\font
_fontTable.Append(@"\");
// If the font's family corresponds to an RTF family, append the
// RTF family name, else, append the RTF for unknown font family.
if (rtfFontFamily.Contains(_f
_fontTable.Append(rtfFontF
else
_fontTable.Append(rtfFontF
// \fcharset specifies the character set of a font in the font table.
// 0 is for ANSI.
_fontTable.Append(@"\fchar
// Append the name of the font
_fontTable.Append(_font.Na
// Close control string
_fontTable.Append(@";}}");
return _fontTable.ToString();
}
/// <summary>
/// Creates a font table from the RtfColor structure. When an Insert or Append
/// operation is performed, _textColor and _backColor are either specified
/// or the default is used. In any case, on any Insert or Append, only three
/// colors are used. The default color of the RichTextBox (signified by a
/// semicolon (;) without a definition), is always the first color (index 0) in
/// the color table. The second color is always the text color, and the third
/// is always the highlight color (color behind the text). The color table
/// should have the form ...
///
/// {\colortbl ;[TEXT_COLOR];[HIGHLIGHT_C
///
/// </summary>
/// <param name="_textColor"></param>
/// <param name="_backColor"></param>
/// <returns></returns>
private string GetColorTable(RtfColor _textColor, RtfColor _backColor) {
StringBuilder _colorTable = new StringBuilder();
// Append color table control string and default font (;)
_colorTable.Append(@"{\col
// Append the text color
_colorTable.Append(rtfColo
_colorTable.Append(@";");
// Append the highlight color
_colorTable.Append(rtfColo
_colorTable.Append(@";}\n"
return _colorTable.ToString();
}
/// <summary>
/// Called by overrided RichTextBox.Rtf accessor.
/// Removes the null character from the RTF. This is residue from developing
/// the control for a specific instant messaging protocol and can be ommitted.
/// </summary>
/// <param name="_originalRtf"></para
/// <returns>RTF without null character</returns>
private string RemoveBadChars(string _originalRtf) {
return _originalRtf.Replace("\0",
}
#endregion
}
}
using System;
using System.Collections.Special
using System.Drawing;
using System.Drawing.Imaging;
using System.IO;
using System.Runtime.InteropServ
using System.Text;
using System.Windows.Forms;
namespace DataShapers.Controls {
#region Public Enums
// Enum for possible RTF colors
public enum RtfColor {
Black, Maroon, Green, Olive, Navy, Purple, Teal, Gray, Silver,
Red, Lime, Yellow, Blue, Fuchsia, Aqua, White, LightGreen
}
#endregion
/// <summary>
/// This class adds the following functionality to RichTextBox:
///
/// 1. Allows plain text to be inserted or appended programmatically to RTF
/// content.
/// 2. Allows the font, text color, and highlight color of plain text to be
/// specified when inserting or appending text as RTF.
/// 3. Allows images to be inserted programmatically, or with interaction from
/// the user.
/// </summary>
/// <remarks>
/// Many solutions to the problem of programmatically inserting images
/// into a RichTextBox use the clipboard or hard code the RTF for
/// the image in the program. This class is an attempt to make the process of
/// inserting images at runtime more flexible without the overhead of maintaining
/// the clipboard or the use of huge, cumbersome strings.
///
/// RTF Specification v1.6 was used and is referred to many times in this document.
/// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnrtfspec/html/rtfspec.asp
///
/// For information about the RichEdit (Unmanaged RichTextBox) ...
/// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/commctls/richedit/richeditcontrols/aboutricheditcontrols.asp
/// </remarks>
public class ExRichTextBox : System.Windows.Forms.RichT
#region My Enums
// Specifies the flags/options for the unmanaged call to the GDI+ method
// Metafile.EmfToWmfBits().
private enum EmfToWmfBitsFlags
{
// Use the default conversion
EmfToWmfBitsFlagsDefault = 0x00000000,
// Embedded the source of the EMF metafiel within the resulting WMF
// metafile
EmfToWmfBitsFlagsEmbedEmf = 0x00000001,
// Place a 22-byte header in the resulting WMF file. The header is
// required for the metafile to be considered placeable.
EmfToWmfBitsFlagsIncludePl
// Don't simulate clipping by using the XOR operator.
EmfToWmfBitsFlagsNoXORClip
};
#endregion
#region My Structs
// Definitions for colors in an RTF document
private struct RtfColorDef {
public const string Black = @"\red0\green0\blue0";
public const string Maroon = @"\red128\green0\blue0";
public const string Green = @"\red0\green128\blue0";
public const string Olive = @"\red128\green128\blue0";
public const string Navy = @"\red0\green0\blue128";
public const string Purple = @"\red128\green0\blue128";
public const string Teal = @"\red0\green128\blue128";
public const string Gray = @"\red128\green128\blue128
public const string Silver = @"\red192\green192\blue192
public const string Red = @"\red255\green0\blue0";
public const string Lime = @"\red0\green255\blue0";
public const string Yellow = @"\red255\green255\blue0";
public const string Blue = @"\red0\green0\blue255";
public const string Fuchsia = @"\red255\green0\blue255";
public const string Aqua = @"\red0\green255\blue255";
public const string White = @"\red255\green255\blue255
public const string LightGreen = @"\red128\green255\blue128
}
// Control words for RTF font families
private struct RtfFontFamilyDef {
public const string Unknown = @"\fnil";
public const string Roman = @"\froman";
public const string Swiss = @"\fswiss";
public const string Modern = @"\fmodern";
public const string Script = @"\fscript";
public const string Decor = @"\fdecor";
public const string Technical = @"\ftech";
public const string BiDirect = @"\fbidi";
}
#endregion
#region My Constants
// Not used in this application. Descriptions can be found with documentation
// of Windows GDI function SetMapMode
private const int MM_TEXT = 1;
private const int MM_LOMETRIC = 2;
private const int MM_HIMETRIC = 3;
private const int MM_LOENGLISH = 4;
private const int MM_HIENGLISH = 5;
private const int MM_TWIPS = 6;
// Ensures that the metafile maintains a 1:1 aspect ratio
private const int MM_ISOTROPIC = 7;
// Allows the x-coordinates and y-coordinates of the metafile to be adjusted
// independently
private const int MM_ANISOTROPIC = 8;
// Represents an unknown font family
private const string FF_UNKNOWN = "UNKNOWN";
// The number of hundredths of millimeters (0.01 mm) in an inch
// For more information, see GetImagePrefix() method.
private const int HMM_PER_INCH = 2540;
// The number of twips in an inch
// For more information, see GetImagePrefix() method.
private const int TWIPS_PER_INCH = 1440;
#endregion
#region My Privates
// The default text color
private RtfColor textColor;
// The default text background color
private RtfColor highlightColor;
// Dictionary that maps color enums to RTF color codes
private HybridDictionary rtfColor;
// Dictionary that mapas Framework font families to RTF font families
private HybridDictionary rtfFontFamily;
// The horizontal resolution at which the control is being displayed
private float xDpi;
// The vertical resolution at which the control is being displayed
private float yDpi;
#endregion
#region Elements required to create an RTF document
/* RTF HEADER
* ----------
*
* \rtf[N] - For text to be considered to be RTF, it must be enclosed in this tag.
* rtf1 is used because the RichTextBox conforms to RTF Specification
* version 1.
* \ansi - The character set.
* \ansicpg[N] - Specifies that unicode characters might be embedded. ansicpg1252
* is the default used by Windows.
* \deff[N] - The default font. \deff0 means the default font is the first font
* found.
* \deflang[N] - The default language. \deflang1033 specifies US English.
* */
private const string RTF_HEADER = @"{\rtf1\ansi\ansicpg1252\
/* RTF DOCUMENT AREA
* -----------------
*
* \viewkind[N] - The type of view or zoom level. \viewkind4 specifies normal view.
* \uc[N] - The number of bytes corresponding to a Unicode character.
* \pard - Resets to default paragraph properties
* \cf[N] - Foreground color. \cf1 refers to the color at index 1 in
* the color table
* \f[N] - Font number. \f0 refers to the font at index 0 in the font
* table.
* \fs[N] - Font size in half-points.
* */
private const string RTF_DOCUMENT_PRE = @"\viewkind4\uc1\pard\cf1\
private const string RTF_DOCUMENT_POST = @"\cf0\fs17}";
private string RTF_IMAGE_POST = @"}";
#endregion
#region Accessors
// TODO: This can be ommitted along with RemoveBadCharacters
// Overrides the default implementation of RTF. This is done because the control
// was originally developed to run in an instant messenger that uses the
// Jabber XML-based protocol. The framework would throw an exception when the
// XML contained the null character, so I filtered out.
public new string Rtf {
get {return RemoveBadChars(base.Rtf);}
set {base.Rtf = value;}
}
// The color of the text
public RtfColor TextColor {
get {return textColor;}
set {textColor = value;}
}
// The color of the highlight
public RtfColor HiglightColor {
get {return highlightColor;}
set {highlightColor = value;}
}
#endregion
#region Constructors
/// <summary>
/// Initializes the text colors, creates dictionaries for RTF colors and
/// font families, and stores the horizontal and vertical resolution of
/// the RichTextBox's graphics context.
/// </summary>
public ExRichTextBox() : base() {
// Initialize default text and background colors
textColor = RtfColor.Black;
highlightColor = RtfColor.White;
// Initialize the dictionary mapping color codes to definitions
rtfColor = new HybridDictionary();
rtfColor.Add(RtfColor.Aqua
rtfColor.Add(RtfColor.Blac
rtfColor.Add(RtfColor.Blue
rtfColor.Add(RtfColor.Fuch
rtfColor.Add(RtfColor.Gray
rtfColor.Add(RtfColor.Gree
rtfColor.Add(RtfColor.Ligh
rtfColor.Add(RtfColor.Lime
rtfColor.Add(RtfColor.Maro
rtfColor.Add(RtfColor.Navy
rtfColor.Add(RtfColor.Oliv
rtfColor.Add(RtfColor.Purp
rtfColor.Add(RtfColor.Red,
rtfColor.Add(RtfColor.Silv
rtfColor.Add(RtfColor.Teal
rtfColor.Add(RtfColor.Whit
rtfColor.Add(RtfColor.Yell
// Initialize the dictionary mapping default Framework font families to
// RTF font families
rtfFontFamily = new HybridDictionary();
rtfFontFamily.Add(FontFami
rtfFontFamily.Add(FontFami
rtfFontFamily.Add(FontFami
rtfFontFamily.Add(FF_UNKNO
// Get the horizontal and vertical resolutions at which the object is
// being displayed
using(Graphics _graphics = this.CreateGraphics()) {
xDpi = _graphics.DpiX;
yDpi = _graphics.DpiY;
}
}
/// <summary>
/// Calls the default constructor then sets the text color.
/// </summary>
/// <param name="_textColor"></param>
public ExRichTextBox(RtfColor _textColor) : this() {
textColor = _textColor;
}
/// <summary>
/// Calls the default constructor then sets te text and highlight colors.
/// </summary>
/// <param name="_textColor"></param>
/// <param name="_highlightColor"></p
public ExRichTextBox(RtfColor _textColor, RtfColor _highlightColor) : this() {
textColor = _textColor;
highlightColor = _highlightColor;
}
#endregion
#region Append RTF or Text to RichTextBox Contents
/// <summary>
/// Assumes the string passed as a paramter is valid RTF text and attempts
/// to append it as RTF to the content of the control.
/// </summary>
/// <param name="_rtf"></param>
public void AppendRtf(string _rtf) {
// Move caret to the end of the text
this.Select(this.TextLengt
// Since SelectedRtf is null, this will append the string to the
// end of the existing RTF
this.SelectedRtf = _rtf;
}
/// <summary>
/// Assumes that the string passed as a parameter is valid RTF text and
/// attempts to insert it as RTF into the content of the control.
/// </summary>
/// <remarks>
/// NOTE: The text is inserted wherever the caret is at the time of the call,
/// and if any text is selected, that text is replaced.
/// </remarks>
/// <param name="_rtf"></param>
public void InsertRtf(string _rtf) {
this.SelectedRtf = _rtf;
}
/// <summary>
/// Appends the text using the current font, text, and highlight colors.
/// </summary>
/// <param name="_text"></param>
public void AppendTextAsRtf(string _text) {
AppendTextAsRtf(_text, this.Font);
}
/// <summary>
/// Appends the text using the given font, and current text and highlight
/// colors.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
public void AppendTextAsRtf(string _text, Font _font) {
AppendTextAsRtf(_text, _font, textColor);
}
/// <summary>
/// Appends the text using the given font and text color, and the current
/// highlight color.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_color"></param>
public void AppendTextAsRtf(string _text, Font _font, RtfColor _textColor) {
AppendTextAsRtf(_text, _font, _textColor, highlightColor);
}
/// <summary>
/// Appends the text using the given font, text, and highlight colors. Simply
/// moves the caret to the end of the RichTextBox's text and makes a call to
/// insert.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_textColor"></param>
/// <param name="_backColor"></param>
public void AppendTextAsRtf(string _text, Font _font, RtfColor _textColor, RtfColor _backColor) {
// Move carret to the end of the text
this.Select(this.TextLengt
InsertTextAsRtf(_text, _font, _textColor, _backColor);
}
#endregion
#region Insert Plain Text
/// <summary>
/// Inserts the text using the current font, text, and highlight colors.
/// </summary>
/// <param name="_text"></param>
public void InsertTextAsRtf(string _text) {
InsertTextAsRtf(_text, this.Font);
}
/// <summary>
/// Inserts the text using the given font, and current text and highlight
/// colors.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
public void InsertTextAsRtf(string _text, Font _font) {
InsertTextAsRtf(_text, _font, textColor);
}
/// <summary>
/// Inserts the text using the given font and text color, and the current
/// highlight color.
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_color"></param>
public void InsertTextAsRtf(string _text, Font _font, RtfColor _textColor) {
InsertTextAsRtf(_text, _font, _textColor, highlightColor);
}
/// <summary>
/// Inserts the text using the given font, text, and highlight colors. The
/// text is wrapped in RTF codes so that the specified formatting is kept.
/// You can only assign valid RTF to the RichTextBox.Rtf property, else
/// an exception is thrown. The RTF string should follow this format ...
///
/// {\rtf1\ansi\ansicpg1252\de
/// \viewkind4\uc1\pard\cf1\f0
///
/// </summary>
/// <remarks>
/// NOTE: The text is inserted wherever the caret is at the time of the call,
/// and if any text is selected, that text is replaced.
/// </remarks>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <param name="_color"></param>
/// <param name="_color"></param>
public void InsertTextAsRtf(string _text, Font _font, RtfColor _textColor, RtfColor _backColor) {
StringBuilder _rtf = new StringBuilder();
// Append the RTF header
_rtf.Append(RTF_HEADER);
// Create the font table from the font passed in and append it to the
// RTF string
_rtf.Append(GetFontTable(_
// Create the color table from the colors passed in and append it to the
// RTF string
_rtf.Append(GetColorTable(
// Create the document area from the text to be added as RTF and append
// it to the RTF string.
_rtf.Append(GetDocumentAre
this.SelectedRtf = _rtf.ToString();
}
/// <summary>
/// Creates the Document Area of the RTF being inserted. The document area
/// (in this case) consists of the text being added as RTF and all the
/// formatting specified in the Font object passed in. This should have the
/// form ...
///
/// \viewkind4\uc1\pard\cf1\f0
///
/// </summary>
/// <param name="_text"></param>
/// <param name="_font"></param>
/// <returns>
/// The document area as a string.
/// </returns>
private string GetDocumentArea(string _text, Font _font) {
StringBuilder _doc = new StringBuilder();
// Append the standard RTF document area control string
_doc.Append(RTF_DOCUMENT_P
// Set the highlight color (the color behind the text) to the
// third color in the color table. See GetColorTable for more details.
_doc.Append(@"\highlight2"
// If the font is bold, attach corresponding tag
if (_font.Bold)
_doc.Append(@"\b");
// If the font is italic, attach corresponding tag
if (_font.Italic)
_doc.Append(@"\i");
// If the font is strikeout, attach corresponding tag
if (_font.Strikeout)
_doc.Append(@"\strike");
// If the font is underlined, attach corresponding tag
if (_font.Underline)
_doc.Append(@"\ul");
// Set the font to the first font in the font table.
// See GetFontTable for more details.
_doc.Append(@"\f0");
// Set the size of the font. In RTF, font size is measured in
// half-points, so the font size is twice the value obtained from
// Font.SizeInPoints
_doc.Append(@"\fs");
_doc.Append((int)Math.Roun
// Apppend a space before starting actual text (for clarity)
_doc.Append(@" ");
// Append actual text, however, replace newlines with RTF \par.
// Any other special text should be handled here (e.g.) tabs, etc.
_doc.Append(_text.Replace(
// RTF isn't strict when it comes to closing control words, but what the
// heck ...
// Remove the highlight
_doc.Append(@"\highlight0"
// If font is bold, close tag
if (_font.Bold)
_doc.Append(@"\b0");
// If font is italic, close tag
if (_font.Italic)
_doc.Append(@"\i0");
// If font is strikeout, close tag
if (_font.Strikeout)
_doc.Append(@"\strike0");
// If font is underlined, cloes tag
if (_font.Underline)
_doc.Append(@"\ulnone");
// Revert back to default font and size
_doc.Append(@"\f0");
_doc.Append(@"\fs20");
// Close the document area control string
_doc.Append(RTF_DOCUMENT_P
return _doc.ToString();
}
#endregion
#region Insert Image
/// <summary>
/// Inserts an image into the RichTextBox. The image is wrapped in a Windows
/// Format Metafile, because although Microsoft discourages the use of a WMF,
/// the RichTextBox (and even MS Word), wraps an image in a WMF before inserting
/// the image into a document. The WMF is attached in HEX format (a string of
/// HEX numbers).
///
/// The RTF Specification v1.6 says that you should be able to insert bitmaps,
/// .jpegs, .gifs, .pngs, and Enhanced Metafiles (.emf) directly into an RTF
/// document without the WMF wrapper. This works fine with MS Word,
/// however, when you don't wrap images in a WMF, WordPad and
/// RichTextBoxes simply ignore them. Both use the riched20.dll or msfted.dll.
/// </summary>
/// <remarks>
/// NOTE: The image is inserted wherever the caret is at the time of the call,
/// and if any text is selected, that text is replaced.
/// </remarks>
/// <param name="_image"></param>
public void InsertImage(Image _image) {
StringBuilder _rtf = new StringBuilder();
// Append the RTF header
_rtf.Append(RTF_HEADER);
// Create the font table using the RichTextBox's current font and append
// it to the RTF string
_rtf.Append(GetFontTable(t
// Create the image control string and append it to the RTF string
_rtf.Append(GetImagePrefix
// Create the Windows Metafile and append its bytes in HEX format
_rtf.Append(GetRtfImage(_i
// Close the RTF image control string
_rtf.Append(RTF_IMAGE_POST
this.SelectedRtf = _rtf.ToString();
}
/// <summary>
/// Creates the RTF control string that describes the image being inserted.
/// This description (in this case) specifies that the image is an
/// MM_ANISOTROPIC metafile, meaning that both X and Y axes can be scaled
/// independently. The control string also gives the images current dimensions,
/// and its target dimensions, so if you want to control the size of the
/// image being inserted, this would be the place to do it. The prefix should
/// have the form ...
///
/// {\pict\wmetafile8\picw[A]\
///
/// where ...
///
/// A = current width of the metafile in hundredths of millimeters (0.01mm)
/// = Image Width in Inches * Number of (0.01mm) per inch
/// = (Image Width in Pixels / Graphics Context's Horizontal Resolution) * 2540
/// = (Image Width in Pixels / Graphics.DpiX) * 2540
///
/// B = current height of the metafile in hundredths of millimeters (0.01mm)
/// = Image Height in Inches * Number of (0.01mm) per inch
/// = (Image Height in Pixels / Graphics Context's Vertical Resolution) * 2540
/// = (Image Height in Pixels / Graphics.DpiX) * 2540
///
/// C = target width of the metafile in twips
/// = Image Width in Inches * Number of twips per inch
/// = (Image Width in Pixels / Graphics Context's Horizontal Resolution) * 1440
/// = (Image Width in Pixels / Graphics.DpiX) * 1440
///
/// D = target height of the metafile in twips
/// = Image Height in Inches * Number of twips per inch
/// = (Image Height in Pixels / Graphics Context's Horizontal Resolution) * 1440
/// = (Image Height in Pixels / Graphics.DpiX) * 1440
///
/// </summary>
/// <remarks>
/// The Graphics Context's resolution is simply the current resolution at which
/// windows is being displayed. Normally it's 96 dpi, but instead of assuming
/// I just added the code.
///
/// According to Ken Howe at pbdr.com, "Twips are screen-independent units
/// used to ensure that the placement and proportion of screen elements in
/// your screen application are the same on all display systems."
///
/// Units Used
/// ----------
/// 1 Twip = 1/20 Point
/// 1 Point = 1/72 Inch
/// 1 Twip = 1/1440 Inch
///
/// 1 Inch = 2.54 cm
/// 1 Inch = 25.4 mm
/// 1 Inch = 2540 (0.01)mm
/// </remarks>
/// <param name="_image"></param>
/// <returns></returns>
private string GetImagePrefix(Image _image) {
StringBuilder _rtf = new StringBuilder();
// Calculate the current width of the image in (0.01)mm
int picw = (int)Math.Round((_image.Wi
// Calculate the current height of the image in (0.01)mm
int pich = (int)Math.Round((_image.He
// Calculate the target width of the image in twips
int picwgoal = (int)Math.Round((_image.Wi
// Calculate the target height of the image in twips
int pichgoal = (int)Math.Round((_image.He
// Append values to RTF string
_rtf.Append(@"{\pict\wmeta
_rtf.Append(@"\picw");
_rtf.Append(picw);
_rtf.Append(@"\pich");
_rtf.Append(pich);
_rtf.Append(@"\picwgoal");
_rtf.Append(picwgoal);
_rtf.Append(@"\pichgoal");
_rtf.Append(pichgoal);
_rtf.Append(" ");
return _rtf.ToString();
}
/// <summary>
/// Use the EmfToWmfBits function in the GDI+ specification to convert a
/// Enhanced Metafile to a Windows Metafile
/// </summary>
/// <param name="_hEmf">
/// A handle to the Enhanced Metafile to be converted
/// </param>
/// <param name="_bufferSize">
/// The size of the buffer used to store the Windows Metafile bits returned
/// </param>
/// <param name="_buffer">
/// An array of bytes used to hold the Windows Metafile bits returned
/// </param>
/// <param name="_mappingMode">
/// The mapping mode of the image. This control uses MM_ANISOTROPIC.
/// </param>
/// <param name="_flags">
/// Flags used to specify the format of the Windows Metafile returned
/// </param>
[DllImportAttribute("gdipl
private static extern uint GdipEmfToWmfBits (IntPtr _hEmf, uint _bufferSize,
byte[] _buffer, int _mappingMode, EmfToWmfBitsFlags _flags);
/// <summary>
/// Wraps the image in an Enhanced Metafile by drawing the image onto the
/// graphics context, then converts the Enhanced Metafile to a Windows
/// Metafile, and finally appends the bits of the Windows Metafile in HEX
/// to a string and returns the string.
/// </summary>
/// <param name="_image"></param>
/// <returns>
/// A string containing the bits of a Windows Metafile in HEX
/// </returns>
private string GetRtfImage(Image _image) {
StringBuilder _rtf = null;
// Used to store the enhanced metafile
MemoryStream _stream = null;
// Used to create the metafile and draw the image
Graphics _graphics = null;
// The enhanced metafile
Metafile _metaFile = null;
// Handle to the device context used to create the metafile
IntPtr _hdc;
try {
_rtf = new StringBuilder();
_stream = new MemoryStream();
// Get a graphics context from the RichTextBox
using(_graphics = this.CreateGraphics()) {
// Get the device context from the graphics context
_hdc = _graphics.GetHdc();
// Create a new Enhanced Metafile from the device context
_metaFile = new Metafile(_stream, _hdc);
// Release the device context
_graphics.ReleaseHdc(_hdc)
}
// Get a graphics context from the Enhanced Metafile
using(_graphics = Graphics.FromImage(_metaFi
// Draw the image on the Enhanced Metafile
_graphics.DrawImage(_image
}
// Get the handle of the Enhanced Metafile
IntPtr _hEmf = _metaFile.GetHenhmetafile(
// A call to EmfToWmfBits with a null buffer return the size of the
// buffer need to store the WMF bits. Use this to get the buffer
// size.
uint _bufferSize = GdipEmfToWmfBits(_hEmf, 0, null, MM_ANISOTROPIC,
EmfToWmfBitsFlags.EmfToWmf
// Create an array to hold the bits
byte[] _buffer = new byte[_bufferSize];
// A call to EmfToWmfBits with a valid buffer copies the bits into the
// buffer an returns the number of bits in the WMF.
uint _convertedSize = GdipEmfToWmfBits(_hEmf, _bufferSize, _buffer, MM_ANISOTROPIC,
EmfToWmfBitsFlags.EmfToWmf
// Append the bits to the RTF string
for(int i = 0; i < _buffer.Length; ++i) {
_rtf.Append(String.Format(
}
return _rtf.ToString();
}
finally {
if(_graphics != null)
_graphics.Dispose();
if(_metaFile != null)
_metaFile.Dispose();
if(_stream != null)
_stream.Close();
}
}
#endregion
#region RTF Helpers
/// <summary>
/// Creates a font table from a font object. When an Insert or Append
/// operation is performed a font is either specified or the default font
/// is used. In any case, on any Insert or Append, only one font is used,
/// thus the font table will always contain a single font. The font table
/// should have the form ...
///
/// {\fonttbl{\f0\[FAMILY]\fch
/// </summary>
/// <param name="_font"></param>
/// <returns></returns>
private string GetFontTable(Font _font) {
StringBuilder _fontTable = new StringBuilder();
// Append table control string
_fontTable.Append(@"{\font
_fontTable.Append(@"\");
// If the font's family corresponds to an RTF family, append the
// RTF family name, else, append the RTF for unknown font family.
if (rtfFontFamily.Contains(_f
_fontTable.Append(rtfFontF
else
_fontTable.Append(rtfFontF
// \fcharset specifies the character set of a font in the font table.
// 0 is for ANSI.
_fontTable.Append(@"\fchar
// Append the name of the font
_fontTable.Append(_font.Na
// Close control string
_fontTable.Append(@";}}");
return _fontTable.ToString();
}
/// <summary>
/// Creates a font table from the RtfColor structure. When an Insert or Append
/// operation is performed, _textColor and _backColor are either specified
/// or the default is used. In any case, on any Insert or Append, only three
/// colors are used. The default color of the RichTextBox (signified by a
/// semicolon (;) without a definition), is always the first color (index 0) in
/// the color table. The second color is always the text color, and the third
/// is always the highlight color (color behind the text). The color table
/// should have the form ...
///
/// {\colortbl ;[TEXT_COLOR];[HIGHLIGHT_C
///
/// </summary>
/// <param name="_textColor"></param>
/// <param name="_backColor"></param>
/// <returns></returns>
private string GetColorTable(RtfColor _textColor, RtfColor _backColor) {
StringBuilder _colorTable = new StringBuilder();
// Append color table control string and default font (;)
_colorTable.Append(@"{\col
// Append the text color
_colorTable.Append(rtfColo
_colorTable.Append(@";");
// Append the highlight color
_colorTable.Append(rtfColo
_colorTable.Append(@";}\n"
return _colorTable.ToString();
}
/// <summary>
/// Called by overrided RichTextBox.Rtf accessor.
/// Removes the null character from the RTF. This is residue from developing
/// the control for a specific instant messaging protocol and can be ommitted.
/// </summary>
/// <param name="_originalRtf"></para
/// <returns>RTF without null character</returns>
private string RemoveBadChars(string _originalRtf) {
return _originalRtf.Replace("\0",
}
#endregion
}
}
ASKER CERTIFIED SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
Bob