Click here to Skip to main content
13,354,605 members (57,102 online)
Click here to Skip to main content
Add your own
alternative version


8 bookmarked
Posted 21 Apr 2012

Add dynamic content controls to a word document

, 21 Apr 2012
Rate this:
Please Sign up or sign in to vote.
Create dynamic content controls at run-time.


This article tells how to add dynamic content controls to an existing Word document at run-time. I assume users have the basic knowledge of office Open XML SDK 2.0.

Code Walkthrough

  1. Create a Word document template which has two content controls.

    Open Microsoft Word. Click on 'Developer' ribbon. Then choose 'Plain text content control'.

    It will add a content control on the document. Click on Properties. This will open Content Properties window. Let us tag the first control as "cc1".

    Similarly create another control and tag it as "cc2". In design mode the two controls would look like

    Save the file as word template ("Doc1.dotx").
  2. Include the Doc1.dotx file in the project, right click on it and set Build action as Content & Copy to output directory as Copy if Newer,

  3. Create two lists that would contain static and dynamic content control tag names.

    private static List<string> staticContentControls = new List<string>() { "cc1", "cc2" };
    private static List<string> dynamicContentControls = new List<string>() { "cc3", "cc4",
                                                                              "cc5" };
  4. In the main method,
  5. static void Main(string[] args)
       // convert template to document
       TemplateToDocument("Doc1.dotx", "Doc1.docx");
       File.Copy("Doc1.docx", "Doc2.docx");
       using (WordprocessingDocument wordDoc = WordprocessingDocument.Open("Doc2.docx", true))
             // add content to static content controls
             // create new content controls
             // add content to dynamically created content controls
  6. TemplateToDocument will convert Doc1.dotx to Doc1.docx.

    MemoryStream presentationStream = null;
    using (Stream tplStream = File.Open(templateFile, FileMode.Open, FileAccess.Read))
       presentationStream = new MemoryStream((int)tplStream.Length);
       presentationStream.Position = 0L;
    using (WordprocessingDocument wordPackage = 
                  WordprocessingDocument.Open(presentationStream, true))
             MainDocumentPart docPart = wordPackage.MainDocumentPart;
             docPart.AddExternalRelationship("" + 
             new Uri(templateFile, UriKind.RelativeOrAbsolute));
      File.WriteAllBytes(documentFile, presentationStream.ToArray());  

    The AddContent method will add a sample text to the content placeholder (I have chosen the sample text to be the tag name of the placeholder itself).

    private static void AddContent(WordprocessingDocument wordDoc)
      var sdtBlocks = wordDoc.MainDocumentPart.Document.Body.ChildElements.OfType<SdtBlock>();
      foreach (SdtBlock block in sdtBlocks)
        if (block.SdtProperties != null)
           Tag blockTag = block.SdtProperties.ChildElements.OfType<Tag>().ElementAt(0);
           if (blockTag != null)
             if (staticContentControls.Contains(blockTag.Val.Value) || 
  7. CreateNewControls would loop through the dynamicContentControls list, create new SdtBlock objects and add them to the Body object of the Document.
  8. dynamicContentControls.ForEach(cc =>
        // creates a new paragraph
        // just to separate the content placeholders
        Paragraph breakParagraph = new Paragraph();
        // create content placeholder
        SdtBlock sdtBlock = new SdtBlock();
        SdtProperties sdtProperties = new SdtProperties();
        Tag tag = new Tag() { Val = cc };
        // other sdtBlock propertoes code
        SdtContentBlock sdtContentBlock = new SdtContentBlock();
        // sdt content block code
        Paragraph paragraph = new Paragraph();
        Run run = new Run()
            RunProperties = new RunProperties()
                RunStyle = new RunStyle()
                    Val = "PlaceholderText"
        Text text = new Text();
        text.Text = "Click here to enter text.";
        // adds the newly created content placeholder to the document
  9. Finally, call the Save() of Document Body object to save the changes done to the document.
  10. wordDoc.MainDocumentPart.Document.Save();

I have attached a sample solution. Please do have a look.


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author

Software Developer
India India
No Biography provided

You may also be interested in...


Comments and Discussions

QuestionLoad image from base64 string to word document Pin
Member 133408677-Dec-17 18:36
memberMember 133408677-Dec-17 18:36 
QuestionOther Program Used in Article Pin
Member 1260057623-Jun-16 6:57
memberMember 1260057623-Jun-16 6:57 
AnswerRe: Other Program Used in Article Pin
pramodhegde8826-Jul-17 0:39
memberpramodhegde8826-Jul-17 0:39 
Questionhow can lock and unlock these dynamic content Pin
mShakeel4u2-Jun-15 13:16
membermShakeel4u2-Jun-15 13:16 
AnswerRe: how can lock and unlock these dynamic content Pin
mShakeel4u3-Jun-15 11:02
membermShakeel4u3-Jun-15 11:02 
QuestionHow can i set the Xpath , Prefixmapping other details. Pin
rajanmanikya8-Mar-15 11:05
memberrajanmanikya8-Mar-15 11:05 
QuestionAdd dynamic content controls to a word document Pin
darrenrhymer30-Apr-14 0:37
memberdarrenrhymer30-Apr-14 0:37 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    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 | Terms of Use | Mobile
Web03 | 2.8.180111.1 | Last Updated 21 Apr 2012
Article Copyright 2012 by pramod.hegde
Everything else Copyright © CodeProject, 1999-2018
Layout: fixed | fluid