Download Source Code
This is the third post of this series. The earlier posts can be read at Part 1 and Part 2.
In Part 1 I discussed about
- Document generation using Content Controls and Open XML 2.0 SDK
- Creating Word templates
- Implementation and Samples
In Part 2 I discussed about
- List of functionalities that can be achieved using the utility/source code
- Description regarding Samples provided with utility
- New samples added in this update
In this part I’ll discuss about the sample that shows one of the ways to “Refresh the document from within the Word(e.g. right click on document and click Refresh) using document-level customizations for Word 2007 and Word 2010“.
On click of Refresh Document the content of the document is refreshed as displayed below
Project “WordDocumentGenerator.WordRefreshableDocumentAddin” has been added to the utility for this sample. The steps followed for creating this sample are listed below.
- Added a new Word 2010 Document project as displayed below
- Updated the document by adding the content controls as displayed below:
- Added a new Command bar button i.e. “Refresh Data” to the Command bar. On click of this button the document will be refreshed. The common scenario
will be to refresh data from the Service. “WordDocumentGenerator.WordRefreshableDocumentAddin” is the document level customization project. This project
references “WordDocumentGenerator.Library” and “WordDocumentGenerator.Client” projects.
The code snippet to add a new Command bar button is:
private CommandBarButton AddCommandBar(CommandBar cmdBr,
int index, string tag, string caption)
CommandBarButton cmdBtn = (CommandBarButton)cmdBr.FindControl(
MsoControlType.msoControlButton, 0, tag, missing, missing);
if ((cmdBtn != null))
cmdBtn = (CommandBarButton)cmdBr.Controls.Add(
MsoControlType.msoControlButton, missing, missing, index, true);
cmdBtn.Style = MsoButtonStyle.msoButtonCaption;
cmdBtn.Caption = caption;
cmdBtn.Tag = tag;
cmdBtn.Visible = true;
cmdBtn.Click -= handler;
cmdBtn.Click += handler;
On click of refresh data the main steps are:
- Get package steam from the document
Microsoft.Office.Interop.Word.Document doc = app.ActiveDocument;
byte input = doc.GetPackageStream();
- Call the Service/Client method that generates/refreshes the document. This can be a Server or a direct call. In this method it’s a direct call.
byte output = AddInService.GenerateDocument(input);
public static byte GenerateDocument(byte documentStream)
- Update the document contents
XDocument xDoc = OPCHelper.OpcToFlatOpc(wordDocument.Package);
string openxml = xDoc.ToString();
These are partial code snippets to show the code flow. For complete sample please download the source code.
Atul works at Microsoft as a .NET consultant. As a consultant his job is to design, develop and deploy enterprise level secure and scalable solutions using Microsoft Technologies.
His technical expertise include .NET Framework(4.0, 3.5, 3.0), WPF, WCF, SharePoint 2010, ASP.net, AJAX, Web Services, Enterprise Applications, SQL Server 2008, Open Xml, MS Word Automation.
Follow him on twitter @verma_atul
He blogs at