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

...

Introducedin
7.1.0.1855

...

7.1.0.1855
Description

Excerpt

Opens a spreadsheet from a SharePoint Document Library.

Signature
C#
C#
public static void Open(this ExcelTemplate template, Microsoft.SharePoint.SPDocumentLibrary docLib, String fileName)
{signature}
{signature:
}
Signature
vb.net
vb.net
Public Shared Sub Open(ByVal template As ExcelTemplate, ByVal docLib As Microsoft.SharePoint.SPDocumentLibrary, ByVal fileName As String)
{signature}
{parameters}
{param:template}The current ExcelTemplate object which is opening the file
{param}
{param:docLib}SharePoint Document Library that contains the Excel spreadsheet being opened
{param}
{param:fileName}The name of the file to open. The file must be a BIFF8 format \(Excel 97 or later\) .xls or .xlt file or an OOXML format .xlsx, .xlsm, .xltx, or .xltm file.
{param}
{exceptions}
{exception:ArgumentNullException}[Open|ExcelTemplate.Open] will throw this exception if {{null}} \(C\#\) or {{Nothing}} \(VB.NET\) is passed to the method.
{exception}
{exception:ArgumentException}
{exception}
{remarks}
{note}This is an extension method for the ExcelTemplate object to be used for opening spreadsheets from SharePoint Document Libraries.  To use this method, you must add a reference to 
Parameters
Param
template
template

The current ExcelTemplate object which is opening the file

Param
docLib
docLib

SharePoint Document Library that contains the Excel spreadsheet being opened

Param
fileName
fileName

The name of the file to open. The file must be a BIFF8 format (Excel 97 or later) .xls or .xlt file or an OOXML format .xlsx, .xlsm, .xltx, or .xltm file.

Exceptions
Exception
ArgumentNullException
ArgumentNullException

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

Exception
ArgumentException
ArgumentException

Remarks
Note

This is an extension method for the ExcelTemplate object to be used for opening spreadsheets from SharePoint Document Libraries. To use this method, you must add a reference to SoftArtisans.OfficeWriter.ExcelWriter.SharePointIntegration.dll

{note} {remarks}