Microsoft Word Documents from ASP.NET

http://www.codeproject.com/KB/aspnet/wordapplication.aspx

Introduction

This article is being written in response of the need of building Microsoft Word document in an ASP.NET project. This article demonstrates how to create and modify document using Microsoft Word with ASP.NET.

Background

Automation is a process that allows applications that are written in languages such as Visual Basic .NET or C# to programmatically control other applications. Automation to Word allows you to perform actions such as creating new documents, adding text to documents, mail merge, and formatting documents. With Word and other Microsoft Office applications, virtually all of the actions that you can perform manually through the user interface can also be performed programmatically by using automation. Word exposes this programmatic functionality through an object model. The object model is a collection of classes and methods that serve as counterparts to the logical components of Word. For example, there is anApplication object, aDocument object, and aParagraph object, each of which contain the functionality of those components in Word.

The project

The first step in manipulating Word in .NET is that you'll need to add a COM reference to your project by right clicking in the solution explorer onReferences->Add Reference. Click on the COM tab and look for the Microsoft Word 10.0 Object Library. ClickSelect and OK.

This will automatically place an assembly in your application directory that wraps COM access to Word.

Now you can instantiate an instance of a Word application:

Collapse |Copy Code

Word.ApplicationClass oWordApp = new Word.ApplicationClass();

You can call the interesting methods and properties that Microsoft Word provides to you to manipulate documents in Word. The best way to learn how to navigate the object models of Word, Excel, and PowerPoint is to use the Macro Recorder in these Office applications:

1. Choose Record New Macro from the Macro option on the Tools menu and execute the task you're interested in.
2. Choose Stop Recording from the Macro option on the Tools menu.
3. Once you are done recording, choose Macros from the Macro option on theTools menu, select the macro you recorded, then clickEdit.

This takes you to the generated VBA code that accomplishes the task you recorded. Keep in mind that the recorded macro willnot be the best possible code in most cases, but it provides a quick and usable example.

For example to open an existing file and append some text:

Collapse |Copy Code

object fileName = "c:\\database\\test.doc";object readOnly = false;object isVisible = true;object missing = System.Reflection.Missing.Value;Word.ApplicationClass oWordApp = new Word.ApplicationClass();Word.Document oWordDoc = oWordApp.Documents.Open(ref fileName,                             ref missing,ref readOnly,                             ref missing, ref missing, ref missing,                             ref missing, ref missing, ref missing,                             ref missing, ref missing, ref isVisible,                             ref missing,ref missing,ref missing);oWordDoc.Activate();oWordApp.Selection.TypeText("This is the text");oWordApp.Selection.TypeParagraph();oWordDoc.Save();oWordApp.Application.Quit(ref missing, ref missing, ref missing);

Or to open a new document and save it:

Collapse |Copy Code

Word.ApplicationClass oWordApp = new Word.ApplicationClass();Word.Document oWordDoc = oWordApp.Documents.Add(ref missing,                            ref missing,ref missing, ref missing);oWordDoc.Activate();oWordApp.Selection.TypeText("This is the text");oWordApp.Selection.TypeParagraph();oWordDoc.SaveAs("c:\\myfile.doc");oWordApp.Application.Quit(ref missing, ref missing, ref missing);

In C#, the Word Document class's Open method signature is defined asOpen(refobject, ref object,ref object,ref object, refobject, refobject, ref object,ref object,ref object, refobject, refobject, ref object,ref object,ref object, refobject). What this means is that in C# theOpen method takes 15 required arguments, and each argument must be preceded with theref keyword and each argument must be of typeobject. Since the first argument is a file name, normally aString value in Visual Basic. NET, we must declare a variable of typeobject that holds the C#string value, hence the code:

Collapse |Copy Code

object fileName = "c:\\database\\test.doc";

Although we only need to use the first argument in the Open method, remember that C# does not allow optional arguments, so we provide the final 14 arguments as variables of typeobject that hold values ofSystem.Reflection.Missing.Value

Use a template

If you are using automation to build documents that are all in a common format, you can benefit from starting the process with a new document that is based on a preformatted template. Using a template with your Word automation client has two significant advantages over building a document from nothing:

• You can have greater control over the formatting and placement of objects throughout your documents.
• You can build your documents with less code.

By using a template, you can fine-tune the placement of tables, paragraphs, and other objects within the document, as well as include formatting on those objects. By using automation, you can create a new document based on your template with code such as the following:

Collapse |Copy Code

Word.ApplicationClass oWordApp = new Word.ApplicationClass();object oTemplate = "c:\\MyTemplate.dot";oWordDoc = oWordApp.Documents.Add(ref oTemplate,               ref Missing,ref Missing, ref Missing);

In your template, you can define bookmarks so that your automation client can fill in variable text at a specific location in the document, as follows:

Collapse |Copy Code

object oBookMark = "MyBookmark";oWordDoc.Bookmarks.Item(ref oBookMark).Range.Text = "Some Text Here";

Another advantage to using a template is that you can create and store formatting styles that you wish to apply at run time, as follows:

Collapse |Copy Code

object oStyleName = "MyStyle";oWordDoc.Bookmarks.Item(ref oBookMark).Range.set_Style(ref oStyleName);