Skip to main content

How to create MS Word documents from Office templates using C#


The OpenXML SDK allows you to do pretty much anything you want with office files such as Excel, Word, etc… While many people like this library, I found it complex, unintuitive and poorly documented, not to mention the awful xml format that uses under the hood to represent the documents, styles, etc. So I decided not to use it and build my own solution. If you, like me, don’t like that library, you will find in this post an alternative approach to build word documents from templates using c#.

A neat trick to work with Office is to use the macro recorder to understand how things work. The macro recorder allows you to start a macro, do something by hand, stop it, and then take a look at the generated VBA code. Once you do this, you are pretty much set.

This is how it looks the template I’am going to use.



Note: save the file as a Word template (.dotx)

This is the code to create Word documents from C#:


By running the code, you should get a document that looks like this.



Note that the font, format, styles, etc. are the same that we defined in the template (Is not just about replacing text)

By the way, don't forget to reference the right version Word interop assembly.



You can grab the code from here  

Comments

  1. If we want to replace more number of words, then how to do it? if i replace more words by finding the word, it is replacing only the word that is given in the last..

    ReplyDelete
    Replies
    1. Hi MuthuKumar, I usually do something like this:

      public class WordWrapper : IWordWrapper {
      private readonly string _templatePath;
      private Application _app;
      private Document _doc;
      private Selection _sel;
      private bool _isDisposed;

      public WordWrapper(string templatePath) {
      _app = new Application();
      _templatePath = templatePath;
      }

      public void OpenTemplate() {
      ValidateFileExistAndIsWordTemplate();

      _doc = _app.Documents.Add(Path.GetFullPath(_templatePath), Visible: false);
      _doc.Activate();
      _sel = _app.Selection;
      }

      public virtual void FindAndReplaceText(string keyword, string replacement) {
      _sel.Find.Text = keyword.ToTemplateFormat();
      _sel.Find.Replacement.Text = replacement;
      _sel.Find.Wrap = WdFindWrap.wdFindContinue;
      _sel.Find.Forward = true;
      _sel.Find.Format = false;
      _sel.Find.MatchCase = false;
      _sel.Find.MatchWholeWord = false;
      _sel.Find.Execute(Replace: WdReplace.wdReplaceAll);
      }
      //some more code but not related to the point...
      }

      And call the function like this:

      _word.OpenTemplate();
      foreach (var keyword in Keywords.Keys)
      _word.FindAndReplaceText(keyword, Keywords[keyword]);

      Where Keywords contains both the placeholder and the value to be put inside that place holder when find a match.
      //i.e. {"[user]","amiralles"},{"[customer]","pipe"}, etc...
      If what do you wanna do is to replace the same place holder, let say [user], with different values, such as iterating over an users collection and do the replacing for each occurrence. I'm afraid you can't do that....
      You can try to start the macro recorder in word, do it by hand and see what code was generated by the macro recorder and try to mimic that code in C# but I've never tried it myself, sorry :\.

      Delete
  2. Hi MuthuKumar,

    Thanks for providing this tutorial.
    Do you know if it would be also possible to replace one of the words with an image which is locally stored?

    Kind regards,


    Marcel

    ReplyDelete
    Replies
    1. Hi Marcel, yes you can, and this is how http://alemiralles.blogspot.com.ar/2013/08/how-to-replace-text-with-images-on-word.html

      Hope this helps!

      Delete
  3. Thanks Amiralles, very useful
    Hi MuthuKumar,
    Try to use Aspose.Words for .NET
    There are good code examples in documentation section. I am sure it can solve your probelm. thanks

    ReplyDelete
  4. how can i insert pictures???? Please help

    ReplyDelete
    Replies
    1. this is how http://alemiralles.blogspot.com.ar/2013/08/how-to-replace-text-with-images-on-word.html
      ;)

      Delete
    2. Thanks helped a lot. Keep up the good work..

      Delete
  5. Check out Docentric toolkit:
    www.docentric.com
    It is a template based document generation toolkit for .NET where you use MS Word to create a template (docx) containing various tags/placeholders and populate it with it's report engine that is 100% .NET and does not rely on MS Word.

    I completely agree with the author about how tedious is to create even the most simple solution using Open XML SDK. Usually it is a lot of effort and many times leads to corrupt documents. But in my opinion Office COM is still a bad doc gen solution although it is a much simpler approach/technique - it is unstable, causes memory/process leaks and should in my view be always avoided.

    ReplyDelete
    Replies
    1. It looks promising, I'll check it out.

      Delete
  6. Valuable information. Thanks for sharing. I actually felt that using templates in your presentation really raise your impression. I have also made a blog and hope you all will like it.
    http://slidehunter-usa.blogspot.in/2015/02/get-creative-office-templates-from.html

    ReplyDelete
    Replies
    1. I'll try one of them in my next presentation. Thanks.

      Delete
  7. Hi Could you please let me know how to use word teamplate dynamically assign values from a Data base. And for each iteration a new document to be created from the template. For example my Word template have a Name field as you mentioned and now i have to dynamically replace that name field with the data from data base. Also need one document per each record. suppose i have some 10 records(i.e Names) in my data base. please share the code. am a novice to this COM objects.

    ReplyDelete
    Replies
    1. Hi Satya, I guess I wouldn't use COM to do that. I'll try to go with something simple, like a plain old for loop and use some names convention to save each document.

      Suppose you query your database and store the result into a variable called tbl, you could do something like this:

      for(var i = 0; i < tbl.Rows.Count; i++) {
      //replace text with tbl.Rows["Name"] // <= most of the code in this post can be used as is.
      doc.SaveAs("names_" + i.ToString());//<= Save using a naming convention
      }

      And you are all set.

      Delete
  8. This comment has been removed by a blog administrator.

    ReplyDelete
    Replies
    1. This is perfect way to describe and you did it well. I was searching similar kind of information and I am glad that I found it. However, I was searching some ready to use templates prepared in MS Word. Please check this resource and guide me.
      Word Templates
      Thanks

      Delete

Post a Comment

Popular posts from this blog

Printing html using the embedded web browser control

In this post I’ll try to answer some questions about the web browser control and provide some workarounds for known issues involved in the printing process.
I'm assuming that you have some experience with the web browser control and basic knowledge of COM and hosting APIs. So I’m not going to cover those topics.
At the bottom of this page I’ve added the links to download a small library I wrote that takes care of printing HTML and a demo app so you can try it out without having to write any code by yourself.
Using the code The HtmlPrinter class will allow you to print html from an URL or just passing the html as string, you can also specify the title and the number of copies you want to print. The code may look something like this: Now that we know how to use the API let get answer some questions.
Why my app crashes when I try to print multiple copies of a page? Well, apparently when you send a lot of print commands to the web browser control, there is a lot of COM crap in between that l…

WinForms, paging the DataGridView the right way

I know this may sound like old history, but in the enterprise world there is still a lot of WinForms development. Just a couple of days ago, I had to implement a custom DataGridView capable to work over a butt load of data (100K+ records) and keep responses times acceptables.
I thought paging will be a good way to go, and as WinForms is pretty old nowadays, I supposed it will be easy to find a couple examples on the web.
While in fact I found examples, all of them were incompletes and/or they wouldn't perform well in real world apps... So I decided to roll my own component and post it online. Hopefully, someone else will find it useful ;).


The bread and butter of this solution relies on LINQ and deferred execution. As LINQ takes care of all complicated work, it was quite easy to implement.
This component also supports conditional format, sorting and some search capabilities, but in this post I will concentrate on paging only (I'll cover the rest of the features in future posts)…