...
Wiki Markup |
---|
{description}
{excerpt}Opens an ExcelWriter template from a {msdn:System.IO.Stream |
...
...
Signature |
---|
C# | C# | }. An ExcelWriter template is a file created in Microsoft Excel that contains data markers where data source values will be inserted.
{excerpt}
{signature:C#}
public virtual void Open(System.IO.Stream stream)
|
Signature |
---|
{signature}
{signature:vb.net | vb.net | }
Public Overridable Sub Open(ByVal stream As System.IO.Stream)
|
Param |
---|
templateStream | templateStream | A {signature}
{parameters}
{param:templateStream}A {{System.IO.Stream}} object, or a class derived from {{System.IO.Stream}} \(for example, {msdn :System.IO.FileStream |System.IO.FileStream |
1 | System.IO.FileStream |
).
...
Open will throw this exception if null
(C#) or Nothing
(VB.NET) is passed to the method.
...
Remarks |
---|
If your template file is the new Office Open XML (.xlsx) format, you can pass it into the ExcelTemplate.Open method just as you would a BIFF8 (.xls) Excel file. You will need to remember to give the output file a ".xlsx" extension when you call Save, as ExcelWriter cannot convert .xlsx files to .xls. |
Example |
---|
Code Block |
---|
| csharp | csharp |
title | C# |
---|
}\).
{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}If your template file is the new Office Open XML \(.xlsx\) format, you can pass it into the [ExcelTemplate.Open|ExcelTemplate.Open] method just as you would a BIFF8 \(.xls\) Excel file. You will need to remember to give the output file a ".xlsx" extension when you call [Save|ExcelTemplate.Save], as ExcelWriter cannot convert .xlsx files to .xls.
{remarks}
{example}{code:csharp|title=C#}
//--- Open an Excel BIFF8 (.xls) file
FileStream oFileStream = New FileStream(@"C:\Templates\Template.xls", FileMode.Open);
oExcelTemplate.Open(oFileStream);
//--- Open an Office Open XML Excel (.xlsx) file
FileStream oFileStream = New FileStream(@"C:\Templates\Template.xlsx", FileMode.Open);
oExcelTemplate.Open(oFileStream);
Code Block |
---|
{code}
{code:vb.net
vb.net | title | |title=vb.net
}
'--- Open an Excel BIFF8 (.xls) file
Dim oFileStream As New FileStream("C:\Templates\Template.xls", FileMode.Open)
oExcelTemplate.Open(oFileStream)
'--- Open an Office Open XML Excel (.xlsx) file
Dim oFileStream As New FileStream("C:\Templates\Template.xlsx", FileMode.Open)
oExcelTemplate.Open(oFileStream)
{code}
{example}