| api_name | api_type | ms.assetid | title | ms.suite | ms.author | author | ms.topic | ms.date | ms.localizationpriority | ||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
360318b5-9d17-42a1-b707-c3ccd1a89c97 |
How to: Open and add text to a word processing document |
office |
o365devx |
o365devx |
conceptual |
02/05/2024 |
high |
This topic shows how to use the classes in the Open XML SDK for Office to programmatically open and add text to a Word processing document.
The Open XML SDK helps you create Word processing document structure
and content using strongly-typed classes that correspond to WordprocessingML elements. This topic shows how
to use the classes in the Open XML SDK to open a Word processing
document and add text to it. In addition, this topic introduces the
basic document structure of a WordprocessingML document, the associated XML
elements, and their corresponding Open XML SDK classes.
In the Open XML SDK, the xref:DocumentFormat.OpenXml.Packaging.WordprocessingDocument class represents a
Word document package. To open and work with a Word document, create an
instance of the xref:DocumentFormat.OpenXml.Packaging.WordprocessingDocument
class from the document. When you create the instance from the document,
you can then obtain access to the main document part that contains the
text of the document. The text in the main document part is represented
in the package as XML using WordprocessingML markup.
To create the class instance from the document you call one of the Open methods. Several are provided, each with a
different signature. The sample code in this topic uses the xref:DocumentFormat.OpenXml.Packaging.WordprocessingDocument.Open(System.String,System.Boolean) method with a signature that requires two parameters. The first parameter takes a full
path string that represents the document to open. The second parameter
is either true or false and represents whether you want the file to
be opened for editing. Changes you make to the document will not be
saved if this parameter is false.
The following code example calls the Open method.
When you have opened the Word document package, you can add text to the main document part. To access the body of the main document part, create any missing elements and assign a reference to the document body, as shown in the following code example.
[!includeStructure]
When you have access to the body of the main document part, add text by adding instances of the xref:DocumentFormat.OpenXml.Wordprocessing.Paragraph, xref:DocumentFormat.OpenXml.Wordprocessing.Run, and xref:DocumentFormat.OpenXml.Wordprocessing.Text classes. This generates the required WordprocessingML markup. The following code example adds the paragraph.
The example OpenAndAddTextToWordDocument
method shown here can be used to open a Word document and append some
text using the Open XML SDK. To call this method, pass a full path
filename as the first parameter and the text to add as the second.
Following is the complete sample code in both C# and Visual Basic.
Notice that the OpenAndAddTextToWordDocument method does not
include an explicit call to Save. That is
because the AutoSave feature is on by default and has not been disabled
in the call to the Open method through use
of OpenSettings.