Click here to Skip to main content
Licence 
First Posted 28 Nov 2002
Views 78,555
Bookmarked 39 times

Helper class to load WinWord

By | 28 Nov 2002 | Article
Simple class to load/unload WinWord (or any other OLE application)

Introduction

In applications I develop, I often use Microsoft Word to generate various documents (reports, agendas, invoices, etc). The code to load and shut down the WinWord's COM server was always the same, so I wrote a simple helper class which manages this.

The Code

using System;
using System.Threading;
using System.Runtime.InteropServices;

namespace AlexKay.Office
{
    /// <summary>
    /// Helper class to manage the Word.Application coclass.
    /// </summary>
    public class WordLoader : IDisposable
    {
        private Word.Application wordApp = null;
        private bool isNewApp = false;

        private bool disposed = false;
        
        public WordLoader()
        {
            // Check if Word is registered in the ROT.
            try
            {
                wordApp = (Word.Application)Marshal.
                    GetActiveObject("Word.Application");
            }
            catch
            {
                wordApp = null;
            }
            // Load Word if it's not.
            if(wordApp == null)
            {
                try
                {
                    wordApp = new Word.ApplicationClass();
                    isNewApp = true;
                }
                catch
                {
                    wordApp = null;
                }
            }
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        protected virtual void Dispose(bool disposing)
        {
            if(!this.disposed)
            {
                if(disposing)
                {
                    // Dispose managed resources.
                }
                
                // Dispose unmanaged resources.
                if(wordApp != null)
                {
                    try
                    {
                        if(isNewApp && wordApp.Documents.Count == 0)
                        {
                            object arg1 = Word.WdSaveOptions.
                                            wdDoNotSaveChanges;
                            object arg2 = null;
                            object arg3 = null;
                            wordApp.Quit(ref arg1, ref arg2, ref arg3);

                            // Wait until Word shuts down.
                            for(;;)
                            {
                                Thread.Sleep(100);
                                try
                                {
                                    // When word shuts down this call 
                                    // throws an exception.
                                    string dummy = wordApp.Version;
                                }
                                catch
                                {
                                    break;
                                }
                            }
                        }
                    }
                    catch {}

                    wordApp = null;
                }
            }
            disposed = true;
        }

        ~WordLoader()
        {
            Dispose(false);
        }

        public Word.Application Application
        {
            get
            {
                return wordApp;
            }
        }
    }
}

Comments

When the WordLoader object is created, it checks if the Word co-class is already created and registered in the running object table. If it's not, it creates a new instance of the Word.Application co-class which loads the WinWord application. When the WordLoader object is disposed it shuts down Word, if it has no documents open.

As you can see, this is quite simple. Any comments on the code are welcome!

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Alexander Kojevnikov

Software Developer (Senior)

Australia Australia

Member



Sign Up to vote   Poor Excellent
Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

 
You must Sign In to use this message board. (secure sign-in)
 
Search this forum  
 FAQ
    Noise  Layout  Per page   
  Refresh
GeneralSlowly. Pinmember123456uio22:41 5 Feb '07  
GeneralA problem. Pinmembershir122:29 18 Sep '06  
GeneralSuggestion Pinmemberxlg5:59 8 Aug '06  
GeneralSweet PinmemberElNoNo11:13 12 Apr '06  
GeneralWinWord in AxWebBrowser Pinmemberpramod.21c19:17 22 Feb '06  
GeneralDoubt.. PinmemberDevangUdeshi3018220:27 17 Apr '05  
GeneralRe: Doubt.. PinmemberAlexander Kojevnikov9:31 19 Apr '05  
GeneralWordAutomation Examples PinmemberNickle10:14 31 Dec '02  
GeneralRe: WordAutomation Examples PinmemberAlexandre Kojevnikov22:27 3 Feb '03  
GeneralSorry to tell you this... PinmemberDavid Stone11:04 29 Nov '02  
GeneralRe: Sorry to tell you this... PinmemberMarc Clifton12:02 29 Nov '02  
GeneralRe: Sorry to tell you this... PinmemberJörgen Sigvardsson14:04 29 Nov '02  
GeneralRe: Sorry to tell you this... PineditorNishant S15:13 29 Nov '02  
GeneralRe: Sorry to tell you this... PinmemberMarc Clifton12:05 29 Nov '02  
GeneralRe: Sorry to tell you this... PineditorNishant S15:12 29 Nov '02  
GeneralRe: Sorry to tell you this... PinmemberAlex Kay6:47 30 Nov '02  
GeneralRe: Sorry to tell you this... PinmemberDavid Stone13:18 30 Nov '02  
GeneralRe: Sorry to tell you this... Pinmembershofb23:25 1 May '08  

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.

Permalink | Advertise | Privacy | Mobile
Web02 | 2.5.120517.1 | Last Updated 29 Nov 2002
Article Copyright 2002 by Alexander Kojevnikov
Everything else Copyright © CodeProject, 1999-2012
Terms of Use
Layout: fixed | fluid