Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

Writes a Document to a stream in the form of a Microsoft Word document.

Signature
C#C#
Wiki Markup
{description}
{excerpt}Writes a [Document|Document] to a stream in the form of a Microsoft Word document.{excerpt}
{signature:C#}
 public void Save(Document doc, System.IO.Stream @out)
Signature
{signature}{signature:vb.net
vb.net
}
Public Sub Save(ByVal doc As Document, ByVal out As System.IO.Stream)
Parameters
{signature}
{parameters}
{param:doc}The {{Document}} to save.{param}
{param:out}The {msdn:System.IO.Stream
to write the file to.
Param
docdoc

The Document to save.

Param
outoutThe
Msdn
System.IO.Stream
1Stream
Exceptions

...

Thrown if there is a problem saving the file.

Remarks

The WordApplication.Preserve property is used to specify the way WordWriter will save the document. When the preserve property is set to true, WordWriter attempts to preserve all formatting and features that it doesn't directly support. This includes Fields, Footnotes, Hyperlinks, Comments, and Anchored Images. When the preserve property is false, only those features directly supported by WordWriter will be preserved. This includes all Tables, Lists, Headers and Footers.

|Stream} to write the file to.{param}
{exceptions}
{exception:System.Exception}Thrown if there is a problem saving the file.{exception}
{remarks}The [WordApplication.Preserve|WordApplication.Preserve] property is used to specify the way WordWriter will save the document. When the {{preserve}} property is set to true, WordWriter attempts to preserve all formatting and features that it doesn't directly support. This includes Fields, Footnotes, Hyperlinks, Comments, and Anchored Images. When the {{preserve}} property is false, only those features directly supported by WordWriter will be preserved. This includes all Tables, Lists, Headers and Footers.

{remarks}
{example}{code:csharp|title=C#}
app.Save(doc, strm);
{code}
{code:vb.net
|title=vb.net
}
app.Save(doc, strm){code}

{example}
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle