Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
maxLevel1

Hello World with ExcelApplication

WordWriter's WordApplication approach provides you with full programmatic control over the binary Word file formats (DOC, DOT). This includes the ability to create and modify: paragraphs, tables, lists, hyperlinks, bookmarks, images and more! This tutorial will show you how to create a new document and write some text to that document.

Diving right into the code

Info

In the Hello World sample web application, WordApplication_HelloWorld.aspx has a text box for users to supply a value and WordApplication_HelloWorld.aspx.cs/vb contains the code show below.

  1. Include the SoftArtisans.OfficeWriter.WordWriter namespace in the code behind.

    Code Block
    languagec#
    using SoftArtisans.OfficeWriter.WordWriter;
    Code Block
    languagevb
    Imports SoftArtisans.OfficeWriter.WordWriter



  2. Instantiate the WordApplication object

    Code Block
    languagec#
    WordApplication WAPP = new WordApplication();
    Code Block
    languagevb
    Dim WAPP As WordApplication = new WordApplication()

     

     

  3. Create a new document with WordApplication.Create()

    Code Block
    languagec#
    Document DOC = WAPP.Create();
    Code Block
    languagevb
    Dim DOC As Document = WAPP.Create()

     

    Unlike the WordTemplate object, which represents a single file, WordApplication works as a file generation engine. The WordApplication object can be used to create, open, and save multiple documents at once.

    Note

    WordApplication only supports the Office 2003 file formats - DOC, DOT. WordWriter does not currently support creating DOCX/DOCM files with WordApplication.

     

     

  4. For this example, we'll pull a value from a text box in a web form. Get the value.

    Code Block
    languagec#
    string value = DataValueBox.Text.Trim();
    Code Block
    languagevb
    Dim value As string = DataValueBox.Text.Trim()
  5. Insert the text into the document with Element.InsertTextAfter.

    Code Block
    languagec#
    DOC.InsertTextAfter(value, true);
    Code Block
    languagevb
    DOC.InsertTextAfter(value, true)

    Text strings need to be inserted into a paragraph, table cell, or list entry elements in a document. In this case, when the text is inserted into the document, it's actually inserted into the last paragraph in the document. Documents created by WordApplication come with a paragraph, so we do not need to create that paragraph.

     

     

  6. Save the output file with WordApplication.Save

    Code Block
    languagec#
    WAPP.Save(DOC, Response, "Output.doc", false);
    Code Block
    languagevb
    WAPP.Save(DOC, Response, "Output.doc", false)

    WordApplication.Save has the same output options as WordTemplate: save to disk, save to memory stream, stream back to the client inline, and stream back to the client as an attachment. In this case, we're streaming the document back to the client as an attachment.

    Here is an example of what the output should look like:

     

Congratulations, you have completed Hello World using WordApplication!

Section
Column
width50
Code Block
languagec#
using SoftArtisans.OfficeWriter.WordWriter;
...
WordApplication WAPP = new WordApplication();

Document DOC = WAPP.Create();

string value = DataValueBox.Text.Trim();

DOC.InsertTextAfter(value, true);

WAPP.Save(DOC, Response, "Output.doc", false);
Column
width50
Code Block
languagevb
Imports SoftArtisans.OfficeWriter.WordWriter
...
Dim WAPP As WordApplication = new WordApplication()

Dim DOC As Document= WAPP.Create()

Dim value As string = DataValueBox.Text.Trim()

DOC.InsertTextAfter(value, true)

WAPP.Save(DOC, Response, "Output.doc", false)

Downloads

You can download the code for the Hello World tutorial as a Visual Studio solution.