Skip to main content

Bindable RichTextBox with HTML conversion in WPF

In WPF, the RichTextBox control is not really like other controls. Due to its flexible nature, there is no built in way of binding a property to the content. In this case, I wanted a simple RichTextBox control with a binding to an HTML formatted string to be able to use the built-in formatting features of the RichTextBox and allow users to create simple HTML formatted content.

First, doing the conversion on-the-fly proved to have major performance issues, so I ended up binding the content to a XAML string. The XAML to HTML conversion can be performed at any time.

I created a UserControl with a bindable Text-property. The view contains a RichTextBox control.

<RichTextBox x:Name="richTextBox" TextChanged="OnRichTextBoxChanged">

The source code for the user control contains the Text property and the methods to handle the binding.

public static readonly DependencyProperty TextProperty = DependencyProperty.Register(
    "Text", typeof(string), typeof(TextEditor),
    new FrameworkPropertyMetadata(string.Empty, FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, OnTextPropertyChanged));

private static void OnTextPropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    textEditor.richTextBox.Document = GetDocumentFromXaml((string) e.NewValue);
}

private void OnRichTextBoxChanged(object sender, TextChangedEventArgs e)
{
    Text = GetXamlFromDocument(richTextBox.Document);
}

private static string GetXamlFromDocument(FlowDocument document)
{
    return XamlWriter.Save(document);
}

private static FlowDocument GetDocumentFromXaml(string xaml)
{
    if (string.IsNullOrEmpty(xaml))
        return new FlowDocument();

    return (FlowDocument)XamlReader.Parse(xaml);
}

Putting this together as a custom control either derived from RichTextBox or just as a simple UserControl as above both works fine. I choose this method since I have exended the control to be more than just a bindable RichTextBox, so this made more sense. When it comes to comverting the XAML to HTML, Microsoft have put together a sample library which does a great job. I haven't had to do any changes to their original code for my scenarios to work, but there might be scenarios where modification is necessary.

Comments

Popular posts from this blog

Moving to the cloud - part 1

I cannot with words describe the hype around the cloud today, and of course I had to join the croud. I have transferred all my applications, files and services to the cloud. I thought I would share some of the experiences and difficulties I have hit during my jourey. These are the steps I have performed in order to complete my move to the cloud: Most of my files are safely stored with  Dropbox . E-mail accounts for stodell.se  were moved from service provider to  Google Apps . The Cornball was moved from service provider to  Windows Azure och SQL Azure . This blog was moved from Wordpress at a service provider to  Google's Blogger . Even though  Loopia has been a great service provider during many years I have now been able to cancel all my services except the domain hosting with them. The replacement being free services and the Azure capacity that is included in the MSDN subscription.

Binding a HTML-formatted string to a WPF WebBrowser control

Sometimes there is a need to display a HTML formatted string in a WPF application. There are a couple of ways to do this, but the most stright forward is to use a WebBrowser control and the NavigateToString method. This approach has one big flaw, you cannot use binding to a string out of the box, but I found a great solution through Stack Overflow which adds a bindable property to the  WebBrowser  control using  NavigateToString . The following class is all that is needed to add that behavior. A new depencency property named Html is introduced to the  WebBrowser  and the proper change action is performed in the OnHtmlChanged method. public class BrowserBehavior { public static readonly DependencyProperty HtmlProperty = DependencyProperty.RegisterAttached( "Html", typeof(string), typeof(BrowserBehavior), new FrameworkPropertyMetadata(OnHtmlChanged)); [AttachedPropertyBrowsableForType(typeof(WebBrowser))] public static string GetHtml(WebBrowser bro

Using Bootstrap Tooltip to show Parsley validation errors

I'm currently working on a web application using a variety of different frameworks, such as Backbone for the back-end, Bootstrap for the front-end and Parsley for client side form validation.  Parsley is a really powerful validation toolkit, but it takes some tweaking to make it blend with the Bootstrap front-end. Fortunately this is a one time fix, which can be re-used all over our project. Since there will be some custom options in our  Parsley  object, we can't use the default parsley-validate attribute on the form. Instead we have to initialize the validation with the jQuery syntax: $('#my-form').parsley(parsleyOptions); The options are were the magic happens, and in our case we have a global options object that our forms use to get the same experience all over the application. Here's what it looks like: var parsleyOptions = {  // Sets success and error class to Bootstrap class names  successClass: 'has-success',  errorClass: 'has-er