Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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.

Signature
C#
C#
  public class ExcelApplication
Signature
vb.net
vb.net

Public Class ExcelApplication
Remarks

A generated workbook is represented by the Workbook class.

To create an instance of ExcelApplication:

In C#:

  • Import ExcelApplication to the C# page:

    Code Block
    csharp
    csharp
    
    using SoftArtisans.OfficeWriter.ExcelWriter;
  • Create an ExcelApplication object:

    Code Block
    csharp
    csharp
    
    ExcelApplication xla = new ExcelApplication();

In VB.NET:

  • Import ExcelApplication to the VB.NET page:

    Code Block
    vbnet
    vbnet
    Imports SoftArtisans.OfficeWriter.ExcelWriter
  • Create an ExcelApplication object:

    Code Block
    vbnet
    vbnet
    Dim xla As New ExcelApplication()

Properties

Name

Description

LicenseKey

Excerpt Include
ExcelApplication.LicenseKey
ExcelApplication.LicenseKey
nopaneltrue

Version

Excerpt Include
ExcelApplication.Version
ExcelApplication.Version
nopaneltrue

Methods

Create()

Create(FileFormat)

Name

Description

ExcelApplication.Create()
nopaneltrue
Excerpt Include
ExcelApplication.Create()
Excerpt Include
ExcelApplication.Create(FileFormat)
ExcelApplication.Create(FileFormat)
nopaneltrue

ExcelApplication()

Excerpt Include
ExcelApplication.ExcelApplication()
ExcelApplication.ExcelApplication()
nopaneltrue

Open(ExcelTemplate)

Excerpt Include
ExcelApplication.Open(ExcelTemplate)
ExcelApplication.Open(ExcelTemplate)
nopaneltrue

Open(String)

Excerpt Include
ExcelApplication.Open(String)
ExcelApplication.Open(String)
nopaneltrue

Open(String, String)

Excerpt Include
ExcelApplication.Open(String, String)
ExcelApplication.Open(String, String)
nopaneltrue

Open(System.IO.Stream)

Excerpt Include
ExcelApplication.Open(System.IO.Stream)
ExcelApplication.Open(System.IO.Stream)
nopaneltrue

Open(System.IO.Stream, String)

Excerpt Include
ExcelApplication.Open(System.IO.Stream, String)
ExcelApplication.Open(System.IO.Stream, String)
nopaneltrue

Save(Workbook, String)

Excerpt Include
ExcelApplication.Save(Workbook, String)
ExcelApplication.Save(Workbook, String)
nopaneltrue

Save(Workbook, System.IO.Stream)

Excerpt Include
ExcelApplication.Save(Workbook, System.IO.Stream)
ExcelApplication.Save(Workbook, System.IO.Stream)
nopaneltrue

Save(Workbook, System.Web.HttpResponse, String, Boolean)

Excerpt Include
ExcelApplication.Save(Workbook, System.Web.HttpResponse, String, Boolean)
ExcelApplication.Save(Workbook, System.Web.HttpResponse, String, Boolean)
nopaneltrue

Save(Workbook, System.Web.HttpResponse, String, Boolean, String)

Excerpt Include
ExcelApplication.Save(Workbook, System.Web.HttpResponse, String, Boolean, String)
ExcelApplication.Save(Workbook, System.Web.HttpResponse, String, Boolean, String)
nopaneltrue

SaveToStream(Workbook)

Excerpt Include
ExcelApplication.SaveToStream(Workbook)
ExcelApplication.SaveToStream(Workbook)
nopaneltrue

Classes

Name

Description

FileFormat

Excerpt Include
ExcelApplication.FileFormat
ExcelApplication.FileFormat
nopaneltrue

Extensionmethods
Introducedin
7.5
7.5

Overload

Description

Open(Microsoft.SharePoint.SPDocumentLibrary, String)

Excerpt Include
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String)
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String)
nopaneltrue

Open(Microsoft.SharePoint.SPListItem, String)

Excerpt Include
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String)
SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String)
nopaneltrue

Save(Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)

Excerpt Include
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)
nopaneltrue

Save(Workbook, Microsoft.SharePoint.SPListItem, String)

Excerpt Include
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String)
SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String)
nopaneltrue