Click here to Skip to main content
Click here to Skip to main content

NRTFTree - A class library for RTF processing in C#

, 7 Sep 2007
Rate this:
Please Sign up or sign in to vote.
Class library to manage RTF files.
NRtfTree Demo Screenshot

Introduction

NRtfTree Library (LGPL) is a set of classes written entirely in C# that may be used to manage RTF documents in your own applications. NRtfTree will help you:

  • Open and parse RTF files.
  • Analyze the content of RTF files.
  • Add, modify and remove document elements (i.e. text, control words, control symbols).
  • Create new RTF documents.

Background

RTF (Rich Text Format) is a method of encoding formatted text and graphics for easy transfer between applications. An RTF document can contain text, images, tables, lists, hyperlinks and many other text and graphic elements. In addition, RTF is the format used internally by the RichTextBox control included as part of .NET Framework. Nevertheless, its functionality is not enough to satisfy all aspects of RTF file management.

Using the Code

NRtfTree has two modes of operation:

  1. DOM-like mode: RTF documents are loaded in a tree structure and are provided several methods to traverse it, access tag contents and modify or create new nodes. This implementation requires the entire content of a document to be parsed and stored in memory.

    In this mode, the main classes are RtfTree and RtfTreeNode:

  2. SAX-like mode: RTF file parser is implemented as an event-driven model in which the programmer provides callback methods that are invoked by the parser as part of its traversal of the RTF document.

    In this mode, the main classes are RtfReader and SARParser:

Examples

The following lines show how you can use the class library in your own code.

  1. DOM-like mode

    This code loads an RTF document into an RtfTree object and inspects all the child nodes:

    public void doSomething()
    {
        //Create the RTF tree object
        RtfTree tree = new RtfTree();
    
        //Load and parse RTF document
        tree.LoadRtfFile("c:\rtfdoc.rtf");
        
        //Get root node
        RtfTreeNode root = tree.RootNode;
    
        RtfTreeNode node = new RtfTreeNode();
    
        for(int i = 0; i < root.ChildNodes.Count; i++)
        {
            node = root.ChildNodes[i];
    
            if(node.NodeType == RTF_NODE_TYPE.GROUP)
            {
                //...
            }
            else if(node.NodeType == RTF_NODE_TYPE.CONTROL)
            {
                //...
            }
            else if(node.NodeType == RTF_NODE_TYPE.KEYWORD)
            {
                switch(nodo.NodeKey)
                    {
                    case "f":  //Font type
                    //...
                    break;
                case "cf":  //Font color
                    //...
                    break;
                case "fs":  //Font size
                    //...
                    break;
                }
            }
            else if(node.NodeType == RTF_NODE_TYPE.TEXT)
            {
                //...
            }
        }
    }
  2. SAX-like mode

    This is an example of the implementation of a simple rft sax-parser:

    public class MyParser : SARParser
    {
        //...
    
        public override void StartRtfDocument()
        {
          doc += 
            "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\r\n";
    
          doc += "<DOCUMENT>\r\n";
        }
    
        public override void EndRtfDocument()
        {
            doc += "\r\n</DOCUMENT>";
        }
        
        public override void StartRtfGroup()
        {
            //...
        }
    
        public override void EndRtfGroup()
        {
            //...
        }
    
        public override void RtfControl(string key, 
                                bool hasParam, int param)
        {
            //..
        }
    
        public override void RtfKeyword(string key, 
                                bool hasParam, int param)
        {
            switch(key)
            {
               case "b":  //bold font
                    //...
                    break;
               case "i":  //Italic font
                    //...
                    break;
               //...
            }
        }
    
        public override void RtfText(string text)
        {
            doc += text;
        }
    }

    Once you have completed the parser, you can start parsing the RTF document by calling the function RtfReader.Parse(). Then the handlers for the configured events are automatically called as many times as necessary:

    //Create the parser
    MiParser parser = new MyParser(res);
    
    //Create the reader and associate the parser
    reader = new RtfReader(parser);
    
    //Load the RTF document
    reader.LoadRtfFile(rutaRTF);
    
    //Start parsing
    reader.Parse();
  3. RtfDocument class

    You can create new RTF documents using the new class RtfDocument (beta):

    RtfDocument doc = new RtfDocument("testdoc.rtf");
    
    RtfTextFormat format = new RtfTextFormat();
    format.size = 20;
    format.bold = true;
    format.underline = true;
    
    doc.AddText("Title", format);
    doc.AddNewLine();
    doc.AddNewLine();
    
    format.size = 12;
    format.bold = false;
    format.underline = false;
    
    doc.AddText("This is a test.", format); 
    doc.AddText("This is a text.");
    
    doc.AddNewLine();
    
    doc.AddImage("test.png", 50, 50);
    
    doc.Close();

Software License

NRtfTree Library is licensed under the GNU LGPL license.

More Information

You can find up-to-date information on my personal home page (Spanish) or NRtfTree SourceForge Project (English).

References

History

  • 2007/09/02 - v0.3.0 beta 1
    • New license: LGPL.
    • New classes to create RTF documents (basic support in beta): RtfDocument, RtfColorTable, RtfFontTable and RtfTextFormat.
    • RtfTree class:
      • New property MergeSpecialCharacters. When it is set to true, if special character is found ('\') it is converted to Text node and eventually merged to adjacent text nodes.
      • New property Text. Returns plain text from the RTF document.
      • New method GetEncoding(). Returns document encoding.
    • RtfTreeNode class:
      • New property Tree. Returns a reference to owner RTF tree.
      • New method To String().
      • New method InsertChild(). Inserts a new node at the specified location.
      • Methods SelectXXXByType() have been replaced by SelectXXX() overloads.
      • New methods SelectSibling() (3 overloads).
    • RtfNodeCollection class:
      • New method Insert(). Inserts a new node at the specified location.
      • New method RemoveRange(). Remove a range of nodes from the list.
    • InfoGroup class:
      • New method ToString().
    • Fixed Bugs:
      • Group and Root node types initialization with "ROOT" and "GROUP".
      • NRtfTree.Rtf property didn't include last '}' in a group node RTF code.
      • NRtfTree does not treat correctly special characters '\', '{' and '}' as part of the text.
      • Methods RtfTreeNode.AppendChild() and InsertChild() should update Root and Tree properties recursively.
  • 2006/12/10 - v0.2.1
    • Fixed - Bug in NRtfTree.SaveRtf() - Special character hex codes with one digit.
  • 2005/12/17 - v0.2.0
    • New namespaces: Net.Sgoliver.NRtfTree.Core and Net.Sgoliver.NRtfTree.Util
    • New classes: ImageNode, ObjectNode, InfoGroup.
    • RtfTreeNode class:
      • New properties: LastChild, NextSibling, PreviousSibling, Rtf.
      • New methods: CloneNode(), HasChildNodes(), SelectSingleNode(), SelectSingleChildNode(), SelectChildNodes(), SelectNodes(), SelectSingleChildNodeType(), SelectChildNodesByType(), SelectNodesByType(), SelectSingleNodeByType().
      • New indexer [equivalent to SelectSingleChildNode()].
      • Some optimization changes.
    • RtfTree class:
      • New methods: ToStringEx(), SaveRtf(), GetColorTable() y GetFontTable() y GetInfoGroup()
      • Some optimization changes.
      • Some bugs fixed.
    • RtfNodeCollection class:
      • New methods: IndexOf(), AddRange()
    • RtfLex class:
      • parseText() now ignores new line, tabs and null characters.
      • Some optimization changes.
  • 2005/08/13 - v0.1
    • First public release.

License

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

About the Author

sgoliver
Web Developer
Spain Spain
Currently, i work for a great consulting company as a software developer.
 
My homepage is:
http://www.sgoliver.net

Comments and Discussions

 
QuestionPasting text part way through a document. PinmemberMember 105013051-May-14 5:03 
QuestionWay too slow for me PinmemberAndiHoffi28-Apr-14 4:09 
GeneralMy vote of 4 PinmemberDiwakar Gupta24-Mar-13 22:57 
QuestionA few enhancements PinmemberTodd C. Gleason11-Sep-12 17:58 
QuestionNRTFTree works incorrect with Unicode, please help [modified] PinmemberWin32nipuh10-Aug-12 1:12 
SuggestionRe: NRTFTree works incorrect with Unicode, please help PinmemberPartyboyone13-Aug-12 4:16 
GeneralRe: NRTFTree works incorrect with Unicode, please help PinmemberWin32nipuh5-Sep-12 2:44 
Questionnot working for table Pinmemberkalyan105224-May-12 3:56 
GeneralMy vote of 5 Pinmembermanoj kumar choubey9-Feb-12 3:06 
GeneralDrawStringRTF PinmemberMartin Welker10-Mar-10 1:05 
QuestionCan it works under windows CE 5.0? Pinmemberliuzhu541928-Jan-10 15:35 
GeneralBackground color Pinmemberilean3-Jan-10 0:49 
GeneralMany Thanks PinmemberBruceG17-Feb-09 11:55 
GeneralRe: Many Thanks PinmemberLGNG9-Jul-09 8:50 
QuestionWhen will the final version of v0.3.0 be available? Pinmemberkmillard5924-Nov-08 9:23 
GeneralRtfTree not working even i have given refence of .DLL Pinmemberspatil198221-Nov-08 0:48 
GeneralRe: RtfTree not working even i have given refence of .DLL PinmemberMember 899618718-May-12 9:02 
QuestionWrong dimension wmetafile images PinmemberNickBlu11-Nov-08 18:50 
GeneralNRtfTree Merge multiple RTF doc PinmemberBoFabio24-Oct-08 0:01 
GeneralRe: NRtfTree Merge multiple RTF doc PinmemberVifani9-Dec-08 5:16 
GeneralRe: NRtfTree Merge multiple RTF doc Pinmemberkevin.yan14-Jun-09 20:29 
GeneralNRtfTree bug fix PinmemberBoFabio23-Oct-08 23:53 
GeneralRe: NRtfTree bug fix PinmemberWin32nipuh18-Jun-09 5:35 
Generalbugfix PinmemberMember 226412521-Aug-08 0:20 
GeneralMerging RTF documents PinmemberOlli Nissinen17-Jun-08 23:32 
GeneralRe: Merging RTF documents PinmemberBoFabio24-Oct-08 0:09 
GeneralRe: Merging RTF documents Pinmembersergio.excelium17-Apr-09 1:11 
GeneralRe: Merging RTF documents Pinmembersergio.excelium17-Apr-09 2:50 
GeneralIssue with other charactersets! PinmemberMember 354931428-May-08 0:04 
QuestionMerge Codes Pinmemberbeachbeamer15-May-08 15:55 
QuestionHow I Can Find and Replace text Pinmemberladakana3-Apr-08 21:11 
AnswerRe: How I Can Find and Replace text PinmemberRuberoid30-Apr-09 5:34 
QuestionRe: How I Can Find and Replace text Pinmembersgoliver1-May-09 0:11 
AnswerRe: How I Can Find and Replace text Pinmemberssomasek4-May-09 8:46 
AnswerRe: How I Can Find and Replace text PinmemberGary Michalek13-Nov-09 10:29 
GeneralHTML PinmemberPQSIK24-Nov-07 12:12 
AnswerRe: HTML [modified] Pinmembersgoliver25-Nov-07 22:11 
GeneralOut of memory exception PinmemberOrsol26-Sep-07 22:58 
AnswerRe: Out of memory exception Pinmembersgoliver29-Sep-07 1:55 
GeneralRe: Out of memory exception PinmemberMember 3238374-Apr-08 8:00 
AnswerRe: Out of memory exception Pinmembersgoliver5-Apr-08 4:42 
GeneralIts fantastic, but the table in rtf is not get parsed [modified] Pinmemberchand.m25-May-07 1:19 
Hi
The library is very good. i hv used it to convert a rtf file to html, but the table in rtf file not get parsed. so the tables in my rtf files appear as plain text in generated html
 
Ananta
 

-- modified at 7:26 Friday 25th May, 2007
GeneralC++ conversion of the Library Pinmemberalamgir mohammed16-Jan-07 17:25 
AnswerRe: C++ conversion of the Library Pinmembersgoliver19-Jan-07 8:32 
GeneralRe: C++ conversion of the Library Pinmembercode_discuss21-Mar-08 20:33 
GeneralRe: C++ conversion of the Library Pinmembersgoliver30-Mar-08 3:43 
GeneralRe: C++ conversion of the Library Pinmemberemadns9-Jul-08 6:36 
GeneralRe: C++ conversion of the Library Pinmembersgoliver2-Nov-08 10:16 
GeneralRe: C++ conversion of the Library PinmemberMember 30874068-Jan-09 20:35 
General'Font Table PinmemberHolpit15-Jan-07 23:35 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    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 | Mobile
Web03 | 2.8.140721.1 | Last Updated 7 Sep 2007
Article Copyright 2005 by sgoliver
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid