Page History

Introducedin

	4.1.0.1379
	4.1.0.1379

Description

Excerpt
Writes a Document to a file and saves it to a SharePoint Document Library.

Signature

	C#
	C#

public static void Save(this WordApplication wordApplication, Document document, Microsoft.SharePoint.SPDocumentLibrary docLib, string fileName, bool overwrite)

Signature

	vb.net
	vb.net

Public Shared Sub Save(ByVal wordApplication As WordApplication, ByVal document As Document, ByVal docLib As Microsoft.SharePoint.SPDocumentLibrary, ByVal fileName As String, ByVal overwrite As Boolean)

Parameters

Param

	wordApplication
	wordApplication

The current WordApplication object from which Save is being called

Param

	document
	document

The Document to save.

Param

	docLib
	docLib

The SharePoint Document Library to which the file will be saved

Param

	fileName
	fileName

Filename of the Document

Param

	overwrite
	overwrite

If true, will overwrite an existing file of the same name in the Document Library

Exceptions

Exception

	System.Exception
	System.Exception

Thrown if there is an error 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.

Note
This is an extension method for the WordApplication object to be used for saving documents to a SharePoint Document Library from within SharePoint. To use this method, you must add a reference to SoftArtisans.OfficeWriter.WordWriter.SharePointIntegration.dll

Example

Code Block

	csharp
	csharp
title	C#

//--- Retrieve current AllowUnsafeUpdates value
bool currentAllowUnsafeUpdates = documentLibrary.ParentWeb.AllowUnsafeUpdates;

//--- You must allow unsafe updates in order for the file to be saved in the
//--- Document Library from a web application
documentLibrary.ParentWeb.AllowUnsafeUpdates = true;
wa.Save(doc, documentLibrary, "populated.doc", true);

//--- Update the document library
documentLibrary.Update();

//--- Return the AllowUnsafeUpdates value to its original state
documentLibrary.ParentWeb.AllowUnsafeUpdates = currentAllowUnsafeUpdates;

Code Block

	vb.net
	vb.net
title	vb.net

'--- Retrieve current AllowUnsafeUpdates value
Dim currentAllowUnsafeUpdates As Boolean = documentLibrary.ParentWeb.AllowUnsafeUpdates

'--- You must allow unsafe updates in order for the file to be saved in the
'--- Document Library from a web application
documentLibrary.ParentWeb.AllowUnsafeUpdates = True
wa.Save(doc, documentLibrary, "populated.doc", True)

'--- Update the document library
documentLibrary.Update()

'--- Return the AllowUnsafeUpdates value to its original state
documentLibrary.ParentWeb.AllowUnsafeUpdates = currentAllowUnsafeUpdates

Space Shortcuts

Page tree

Versions Compared

Old Version 11

New Version Current

Key