Inserting newlines in Word using OpenXML

Question

I am using openxml WordProcessingDocument to open a Word template and replace placeholder x1 with a string. This works fine unless I need the string to contain a newline. How can I replace x1 with text may contain newlines that word would recognise? I have tried \n \r but these do not work

Just to explain further when the word template is opened I read it into a StreamReader then use .Replace to replace x1.

It's not awesome but: `.Replace(Environment.NewLine, "")` might work for you. — BrainSlugs83, Dec 07 '13 at 09:52
@BrainSlugs83: Any idea about this? http://stackoverflow.com/questions/26307691 — slayernoah, Oct 10 '14 at 21:13

score 111 · Accepted Answer · edited Sep 17 '15 at 15:48

111

To insert newlines, you have to add a Break instance to the Run.

Example:

run.AppendChild(new Text("Hello"));
run.AppendChild(new Break());
run.AppendChild(new Text("world"));

The XML produced will be something like:

<w:r>
  <w:t>Hello</w:t>
  <w:br/>
  <w:t>world</w:t>
</w:r>

edited Sep 17 '15 at 15:48

outofmind

1,430
1
20
37

answered May 20 '10 at 08:02

codeape

97,830
24
159
188

I don't think I can use your answer in my situation. I updated my question to explain further – Danny May 20 '10 at 09:18
So you're working with the XML directly? In that case, try inserting XML like the example. – codeape May 20 '10 at 10:22
2

Note, that in PPTX / PresentationML the `Break()` has to be child of the `Paragraph`, not child of the `Run` – outofmind Sep 17 '15 at 13:07

Toolsmythe · Answer 2 · 2011-10-10T06:05:03.253

30

Here's a C# function that will take a string, split it on line breaks and render it in OpenXML. To use, instantiate a Run and pass it into the function with a string.

void parseTextForOpenXML( Run run, string textualData )
{
    string[ ] newLineArray = { Environment.NewLine };
    string[ ] textArray = textualData.Split( newLineArray, StringSplitOptions.None );

    bool first = true;

    foreach ( string line in textArray )
    {
        if ( ! first )
        {
            run.Append( new Break( ) );
        }

        first = false;

        Text txt = new Text( );
        txt.Text = line;
        run.Append( txt );
    }

edited Oct 10 '11 at 06:05

answered Oct 07 '11 at 22:55

Toolsmythe

411
5
7

1

niceeeee solution,thank's a lot, i use this solution when my string contains \n\r – habiat Dec 07 '14 at 14:34
4

Thanks, I modified `string[ ] newlineArray = { Environment.NewLine, "\n", "\r\n", "\n\r" }` to make it work for all type of break. 8 years past but still it's the best answer. – its4zahoor Feb 14 '19 at 12:45

score 13 · Answer 3 · edited Dec 06 '21 at 14:01

13

Altough this question is already answered I have another approach to solve questions like :

How can I make XXX with OpenXML??

In this cases you could make use of the powerful Microsoft OpenXML productivity tool (also known as OpenXmlSdkTool). Download here.

Create a new office document
Add the parts to the document which you would like to reproduce with OpenXML SDK.
Open the office document with Microsoft OpenXML productivity tool
Click on "Reflect Code"
On the right side you will see now you document reflected into C# code.

edited Dec 06 '21 at 14:01

Christian Junk

1,000
1
8
22

answered Dec 02 '14 at 15:54

Mischa

635
6
14

This is a great answer! I was after working out some tricky open xml bits and had to google the inner workings of almost every element. Having a tool which can output the trick bits and paste them in is a major timesaver, thanks. – dougajmcdonald Dec 11 '15 at 09:52

score 12 · Answer 4 · edited Mar 29 '12 at 10:32

12

I have the same issue and in my case <w:br /> tag worked.

edited Mar 29 '12 at 10:32

cha0site

10,517
3
33
51

answered Mar 29 '12 at 10:19

parm

121
1
2

Worked like a charm! Tank you very much! – BertuPG Dec 03 '15 at 13:17

Inserting newlines in Word using OpenXML

4 Answers4

Linked

Related