Click here to Skip to main content
14,211,690 members
Click here to Skip to main content
Article
Posted 7 Feb 2009

Tagged as

Stats

129.7K views
1.1K downloads
34 bookmarked

WPF Html supported TextBlock

,
Rate this:
4.36 (9 votes)
Please Sign up or sign in to vote.
4.36 (9 votes)
7 Feb 2009     LGPL3    
This Article describes HtmlTextBlock, which is a WPF TextBlock that can parse limited set of html tags and display them.
This is an old version of the currently published article.
mainscreen.jpg

Introduction

This Article describes HtmlTextBlock, which is a WPF TextBlock that can parse limited set of html tags and display them.

Background

I was working on a custom progress dialog, which contains a Header, Message, Progress and some action button,
To make it look better, I want the message to support some text format, and I want it to be changeable at runtime, but it seems impossible using TextBlock.

background.jpg


I then googled how to use html in wpf but most solutions told me to use WebBrowser, which is a bit overkill for my purpose. 

Then I remembered an abondoned project I wrote few years ago (mostly because I moved to WPF) , which tried to recreate FlowDocument in dotNet2, and load Html to that flow document (my main purpose, the component was named QzMiniHtml2).

Surprisingly, with very few modifications (mostly using import), this dotNet2 project work nicely with WPF, just as you look above.

Because of this, the original project is also included as well.

How to use? 

The control is similar to TextBlock except you set the Html property instead of Text.
Remember to use [ ] bracket instead of < >.
<Window x:Class="HtmlTextBlockTestProj.Window1"

    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

    xmlns:uc="http://www.quickzip.org/UserControls"

    Title="HtmlTextBlockTest" Height="250" Width="450">
    <DockPanel>
        <uc:HtmlTextBlock Html="{Binding Text, ElementName=tb}"  

                 DockPanel.Dock="Top" Loaded="HtmlTextBlock_Loaded" />
        <TextBlock Text="[b] [i] [u] [a href=xx] [br] supported." 

                 DockPanel.Dock="Bottom" />
        <TextBox TextWrapping="Wrap" AcceptsReturn="True" 

                  VerticalScrollBarVisibility="Visible"

                  x:Name="tb" 

        Text="The [i][u]quick brown fox[/i][/u] jumps over the [b]lazy dog[/b]" />
    </DockPanel>
</Window>		 

How it works? 

The component actually included a html parsing engine inside, which translate html string to WPF's Bold, Italic, Underline, Hyperlink, LineBreak Inline
(more can be added in future, you can do it yourself easily, see below)

The conversion part is simple.

1) private Inline UpdateElement(HtmlTag aTag)
2) {
3)   Inline retVal = null;
			
4)   switch (aTag.Name)
5)   {
6)     case "text" : 
7)       retVal = new Run(aTag["value"]);			
8)       if (currentState.Bold) retVal = new Bold(retVal);
9)       if (currentState.Italic) retVal = new Italic(retVal);
0)       if (currentState.Underline) retVal = new Underline(retVal);
A)       break;
B)     case "br" : 
C)       retVal = new LineBreak();
D)       break;
E)   }

F)   if (currentState.HyperLink != null && currentState.HyperLink != "")
G)   {
H)     Hyperlink link = new Hyperlink(retVal);
I)     link.NavigateUri = new Uri(currentState.HyperLink);
J)     retVal = link;
K)   }			
L)    return retVal;
M) }		 
First, please note that
  • The input (aTag) is a Text or LineBreak(br), if the tag is a text, Tag["value"] is the text it holds.
    Bold, Italic etc can also be represented by HtmlTag, but they wont be executed here.
  • CurrentState hold the style affecting the TextTag etc
So if the tag is text (line 6),
  • it will generate a Run (which can contain format or unformat text, and unformat in this case) (line 7)
  • if it's bold, italic and underline, it will construct them, and using last Inline (Abstract class, Run, Bold etc inherited from it), so it contain the property.
When the Inline is returned (Line L)
  • It will be added to your HtmlTextBlock.Inlines collection. 

History

08-02-09 Initial version 

License

This article, along with any associated source code and files, is licensed under The GNU Lesser General Public License (LGPLv3)

Share

About the Author

Leung Yat Chun (Fainx)
Founder FANIX.ME
Hong Kong Hong Kong
From the end of the Universe we have Fainx and Quick Zip.
http://www.FANIX.ME
Quickzip.org is stolen by and moved to Fanix.me.
--
May Thy Lord Your God be blessed always.

DirectoryInfoEx - [1.0.27]
WPF FileExplorer3 - [3.0.19]
WPF HtmlTextBlock - [Codeplex]
WPF ListView MultiSelect - [0.4]
WPF UIEventHub MultiSelect/DragDrop w Touch support - [3.0]
WPF BreadcrumbFolderTextBox - [2.5]
WPF BreadcrumbTree and Breadcrumb
WPF Aero Titlebar - [0.2]

Comments and Discussions

Discussions on this specific version of this article. Add your comments on how to improve this article here. These comments will not be visible on the final published version of this article.
 
QuestionEscape character for [ and ]. Pin
User 136423586-Aug-18 5:54
memberUser 136423586-Aug-18 5:54 
QuestionChanging mouse on hover? Pin
Andy Cartwright30-Aug-15 9:53
memberAndy Cartwright30-Aug-15 9:53 
QuestionHow to handle click Event Pin
Member 1118186626-Oct-14 16:07
memberMember 1118186626-Oct-14 16:07 
AnswerRe: How to handle click Event Pin
Leung Yat Chun (Fainx)26-Oct-14 23:59
professionalLeung Yat Chun (Fainx)26-Oct-14 23:59 
GeneralRe: How to handle click Event Pin
Member 1168374112-May-15 2:26
memberMember 1168374112-May-15 2:26 
GeneralMy vote of 1 Pin
starsky_chen6-Jan-13 5:16
memberstarsky_chen6-Jan-13 5:16 
QuestionUnable to download the attached sample Pin
ksvimalraj28-Jul-11 17:28
memberksvimalraj28-Jul-11 17:28 
AnswerRe: Unable to download the attached sample Pin
Leung Yat Chun (Fainx)29-Jul-11 3:52
professionalLeung Yat Chun (Fainx)29-Jul-11 3:52 
GeneralSmall bug Pin
ArlenFeldman25-Mar-11 14:55
memberArlenFeldman25-Mar-11 14:55 
GeneralThis is ... Pin
Xmen Real 2-Jul-10 5:25
professional Xmen Real 2-Jul-10 5:25 
GeneralSaving me a lot of time! Pin
MikePelton12-Dec-09 5:01
memberMikePelton12-Dec-09 5:01 
Generalimage in text block Pin
pathurun8-Sep-09 21:35
memberpathurun8-Sep-09 21:35 
GeneralRe: image in text block Pin
Leung Yat Chun (Fainx)15-Sep-09 0:56
professionalLeung Yat Chun (Fainx)15-Sep-09 0:56 
GeneralDoes not work if Html Text is assigned to the HtmlTextBlock during Binding Pin
azamsharp1-Jul-09 10:09
memberazamsharp1-Jul-09 10:09 
GeneralRe: Does not work if Html Text is assigned to the HtmlTextBlock during Binding Pin
Leung Yat Chun (Fainx)2-Jul-09 7:06
professionalLeung Yat Chun (Fainx)2-Jul-09 7:06 
Generalextensions Pin
Lee_Nover20-Mar-09 15:11
memberLee_Nover20-Mar-09 15:11 
GeneralRe: extensions Pin
Leung Yat Chun (Fainx)20-Mar-09 20:35
professionalLeung Yat Chun (Fainx)20-Mar-09 20:35 
GeneralRe: extensions Pin
Lee_Nover23-Mar-09 4:14
memberLee_Nover23-Mar-09 4:14 
GeneralRe: extensions Pin
Leung Yat Chun (Fainx)23-Mar-09 10:20
professionalLeung Yat Chun (Fainx)23-Mar-09 10:20 
GeneralRe: extensions Pin
Lee_Nover24-Mar-09 3:45
memberLee_Nover24-Mar-09 3:45 
GeneralRe: extensions Pin
Leung Yat Chun (Fainx)25-Mar-09 9:20
professionalLeung Yat Chun (Fainx)25-Mar-09 9:20 
GeneralRe: extensions Pin
Bob Ranck4-Apr-09 9:26
memberBob Ranck4-Apr-09 9:26 
GeneralRe: extensions Pin
Leung Yat Chun (Fainx)5-Apr-09 20:45
professionalLeung Yat Chun (Fainx)5-Apr-09 20:45 
QuestionFlow document? Pin
Member 17809897-Feb-09 21:32
memberMember 17809897-Feb-09 21:32 
AnswerRe: Flow document? Pin
Leung Yat Chun (Fainx)7-Feb-09 22:39
professionalLeung Yat Chun (Fainx)7-Feb-09 22:39 

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.


Layout: fixed | fluid

Article Copyright 2009 by Leung Yat Chun (Fainx)
Everything else Copyright © CodeProject, 1999-2019

Server Web01
Version 2.8.190619.2