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.SPListItem listItem, String fileName)
{signature}{signature:vb.net}
Public Overridable Sub Save(ByVal excelApplication As ExcelApplication, ByVal workbook As Workbook, ByVal listItem As Microsoft.SharePoint.SPListItem, ByVal fileName As String)
{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:listItem}SharePoint List Item to which the file is attached{param}
{param:fileName}Specifies a file name for the Workbook. ExcelWriter will save the file as an attachment to the List Item using this name.{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 List Items.  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 = list.ParentWeb.AllowUnsafeUpdates;

//--- You must allow unsafe updates in order for the file to be saved in the
//--- List from a web application
list.ParentWeb.AllowUnsafeUpdates = true;
xla.Save(wb, listItem, "populated.xls");

//--- Update the list
listItem.Update();

//--- Return the AllowUnsafeUpdates value to its original state
list.ParentWeb.AllowUnsafeUpdates = currentAllowUnsafeUpdates;
        {code}
{code:vb.net|title=vb.net}
'--- Retrieve current AllowUnsafeUpdates value
Dim currentAllowUnsafeUpdates As Boolean = list.ParentWeb.AllowUnsafeUpdates

'--- You must allow unsafe updates in order for the file to be saved in the
'--- List from a web application
list.ParentWeb.AllowUnsafeUpdates = True
xla.Save(wb, listItem, "populated.xls")

'--- Update the list
listItem.Update()

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

{example}