Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup
{introducedin:7.1.0.1855}
{description}
{excerpt}Saves a specified [Workbook|Workbook] as a BIFF8 format \(Excel 97 or later\) .xls file.{excerpt}
{signature:C#}
public static void Save(this ExcelApplication excelApplication, Workbook workbook, Microsoft.SharePoint.SPDocumentLibrary docLib, String fileName, bool overwrite)
{signature}{signature:vb.net}
Public Overridable Sub Save(ByVal excelApplication As ExcelApplication, ByVal workbook As Workbook, ByVal docLib As Microsoft.SharePoint.SPDocumentLibrary, ByVal fileName As String, ByVal overwrite As Boolean)
{signature}
{parameters}
{param:excelApplication}The current ExcelApplication object which is saving the workbook to file{param}
{param:workbook}A {{Workbook}} object representing the workbook to save.{param}
{param:docLib}SharePoint Document Library that contains the Excel spreadsheet being opened{param}
{param:fileName}Specifies a file name for the Workbook. ExcelWriter will save the file to the document library using this name.  If a file with the same name exists, it will be overwritten by the new Excel file if the overwrite parameter is set to True.{param}
{param:overwrite}Set to True to overwrite an Excel file if one already exists by that name in the Document Library{param}
{exceptions}
{exception:System.Exception}If there is a problem creating, opening, or writing to the file specified, or reading from the workbook object.{exception}
{remarks}
{note}This is an extension method for the ExcelApplication object to be used for saving spreadsheets to SharePoint Document Libraries.  To use this method, you must add a reference to SoftArtisans.OfficeWriter.ExcelWriter.SharePointIntegration.dll{note}

{remarks}
{example}
{code: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;
xla.Save(wb, documentLibrary, "populated.xls", true);

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

//--- Return the AllowUnsafeUpdates value to its original state
documentLibrary.ParentWeb.AllowUnsafeUpdates = currentAllowUnsafeUpdates;
{code}
{code: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
xla.Save(wb, documentLibrary, "populated.xls", True)

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

'--- Return the AllowUnsafeUpdates value to its original state
documentLibrary.ParentWeb.AllowUnsafeUpdates = currentAllowUnsafeUpdates
{code}
{example}