OfficeWriter Documentation
.
ExcelWriter v8 Docs
Space Shortcuts
Page tree
ConfigureSpace tools

Versions Compared

Old Version 16

changes.mady.by.user Stephanie Rosario [softartisans]

Saved on

compared with

New Version Current

changes.mady.by.user Stephanie Rosario [softartisans]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

Opens a Workbook from an ExcelTemplate object.

Signature
C#
C#
 public virtual Workbook Open(ExcelTemplate excelTemplate)
{signature}{signature:
}
Signature
vb.net
vb.net
Public Overridable Function Open(ByVal excelTemplate As ExcelTemplate) As Workbook
{signature}
{parameters}
{param:excelTemplate}An {{ExcelTemplate}} object representing the workbook to open.{param}
{returns}Workbook that is opened.{returns}
{remarks}
If your template file is the new Office Open XML (.xlsx) format, you can pass it into the [ExcelApplication.Open|EW8:ExcelApplication.Open(ExcelTemplate)] 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 |EW8:ExcelApplication.Save]as ExcelWriter cannot convert .xlsx files to .xls

{remarks}


{exceptions}
{exception:System.Exception}If there is a problem creating, opening, or writing to the  file specified, or reading from the {{Workbook}} object.{exception}
{example}{code:csharp|title=C#}
Parameters
Param
excelTemplate
excelTemplate

An ExcelTemplate object representing the workbook to open.

Returns

Workbook that is opened.

Remarks

If your template file is the new Office Open XML (.xlsx) format, you can pass it into the ExcelApplication.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

Exceptions
Exception
System.Exception
System.Exception

If there is a problem creating, opening, or writing to the file specified, or reading from the Workbook object.

Example
Code Block
csharp
csharp
titleC#


          ExcelTemplate xlt = new ExcelTemplate();

          //--- Do something with template here

          ExcelApplication xla = new ExcelApplication();
          xla.Open(xlt);
{code} {code:
 Code Block
vb.net
|title=
vb.net
titlevb.net
}


          Dim xlt As New ExcelTemplate()

          '--- Do something with template here

          Dim xla As New ExcelApplication()
          xla.Open(xlt)
        
{code}

{example}