Forums     Knowledge Base     OfficeWriter Online     
 
 
This documentation is for
OfficeWriter v3.7.1
.NET Platform

View Docs for Another
Version or Platform

Programmer's Reference > ExcelApplication API > ExcelApplication

The ExcelApplication Object


ExcelApplication is the main class for pure code-based workbook generation (for information about template-based workbook generation, see ExcelTemplate ). This class is an engine used to open, create, and write (save or stream to a browser) workbooks. A single instance of ExcelApplication can generate multiple workbooks.

A generated workbook is represented by the Workbook class.

To create an instance of ExcelApplication:

In C#:

  1. Import ExcelApplication to the C# page:

    using SoftArtisans.OfficeWriter.ExcelWriter;

  2. Create an ExcelApplication object:

    ExcelApplication xla = new ExcelApplication();

In VB.NET:

  1. Import ExcelApplication to the C# page:

    Imports SoftArtisans.OfficeWriter.ExcelWriter;

  2. Create an ExcelApplication object:

    Dim xla As New ExcelApplication()


ExcelApplication Properties

Property Type Access Description
LicenseKey String read
write

The LicenseKey property is provided to assist in debugging license-related issues

Version String read

Returns the exact version of ExcelWriter



ExcelApplication Methods

ReturnsSignature and Description
Workbook Create ( )

Creates a new workbook containing 1 worksheet

Workbook Open ( ExcelTemplate excelTemplate )

Opens a Workbook from an ExcelTemplate object

Workbook Open ( String fileName )

Opens an existing Excel spreadsheet

Workbook Open ( String fileName , String decryptPassword )

Opens an existing Excel spreadsheet

Workbook Open ( System.IO.Stream stream )

Opens an Excel workbook from a stream and returns a Workbook object

Workbook Open ( System.IO.Stream stream , String decryptPassword )
void Save ( Workbook workbook , String fileName )

Saves a specified Workbook as a BIFF8 format (Excel 97 or later) .xls file

void Save ( Workbook workbook , System.IO.Stream stream )

Saves a specified Workbook as a BIFF8 format (Excel 97 or later).xls file

void Save ( Workbook workbook , System.Web.HttpResponse response , String fileName , boolean openInBrowser )

Streams the specified workbook to the client

void Save ( Workbook workbook , System.Web.HttpResponse response , String fileName , boolean openInBrowser , String contentType )

Streams the specified workbook to the client



Copyright 2006 © SoftArtisans, Inc. All Rights Reserved.