Page History

Introducedin

	4.1.0.1379
	4.1.0.1379

Description

Excerpt
Saves the generated Word file to a SharePoint Document Library.

Signature

	C#
	C#

public static void Save(this WordTemplate template, Microsoft.SharePoint.DocumentLibrary docLib, string fileName, bool overwrite)

Signature

	vb.net
	vb.net

Public Shared Sub Save(ByVal template As WordTemplate, ByVal docLib As Microsoft.SharePoint.DocumentLibrary, ByVal fileName As String, ByVal overwrite As Boolean)

Parameters

Param

	template
	template

The current WordTemplate object that is being saved to file

Param

	docLib
	docLib

SharePoint document library to which the file is being saved

Param

	fileName
	fileName

Name of the file to be saved

Param

	overwrite
	overwrite

If set to true, will overwrite any files in the Document Library by that name

Exceptions

Exception

	ArgumentNullException
	ArgumentNullException

Save will throw this exception if null (C#) or Nothing (VB.NET) is passed to the method.

Remarks

You can call Save more than once for a single instance of WordTemplate. This allows you to save more than one copy of a generated file, and/or both save the file on the server and stream it to the client.

Note
This is an extension method for the WordTemplate 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;
wt.Save(documentLibrary, "populated.docx", 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
wt.Save(documentLibrary, "populated.docx", 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 12

New Version Current

Key