Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
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}
{remarks}A generated workbook is represented by the [Workbook|Workbook] class.

To create an instance of {{ExcelApplication}}:

In C\#:

* Import {{ExcelApplication}} to the C\# page: {code:csharp}
using SoftArtisans.OfficeWriter.ExcelWriter;
Create an ExcelApplication object:
{code}

* Create an {{ExcelApplication}} object: {code:csharp}
ExcelApplication xla = new ExcelApplication();
In
{code}



In VB.NET:
Import ExcelApplication to the


* Import {{ExcelApplication}} to the VB.NET page:

{code
:vbnet
}Imports SoftArtisans.OfficeWriter.ExcelWriter
Create an ExcelApplication object:
{code}

* Create an {{ExcelApplication}} object: \{code:vbnet}Dim xla As New ExcelApplication()
Signature
C#C#
Wiki Markup
{description}
{excerpt}[ExcelApplication|ExcelApplication] is the main class for pure code\-based workbook generation \(for information about template\-based workbook generation, see [ExcelTemplate|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.{excerpt}
{signature:C#}
 public class ExcelApplication
Signature
{signature}{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
csharpcsharp
Code Block
csharpcsharpvbnet
Code Block
Properties

...

Name

...

Description

...

LicenseKey

...

Version

...

Methods

...

Name

...

Description

...

Create()

...

{code}


{remarks}
{properties}
||Name||Description||
|[LicenseKey|ExcelApplication.LicenseKey]|{excerpt-include:ExcelApplication.LicenseKey|nopanel=true}|
|[Version|ExcelApplication.Version]|{excerpt-include:ExcelApplication.Version|nopanel=true}|
{methods}
||Name||Description||
|[Create()|ExcelApplication.Create()]|{excerpt-include:ExcelApplication.Create()

...

|nopanel

...

=true}|
|[Create(FileFormat)

...

|ExcelApplication.Create(FileFormat)

...

]|{excerpt-include:ExcelApplication.Create(FileFormat)

...

|nopanel

...

=true}|
|[ExcelApplication()

...

|ExcelApplication.ExcelApplication()

...

]|{excerpt-include:ExcelApplication.ExcelApplication()

...

|nopanel

...

=true}|
|[Open(ExcelTemplate)

...

|ExcelApplication.Open(ExcelTemplate)

...

]|{excerpt-include:ExcelApplication.Open(ExcelTemplate)

...

|nopanel

...

=true}|
|[Open(String)

...

|ExcelApplication.Open(String)

...

]|{excerpt-include:ExcelApplication.Open(String)

...

|nopanel

...

=true}|
|[Open(String, String)

...

|ExcelApplication.Open(String, String)

...

]|{excerpt-include:ExcelApplication.Open(String, String)

...

|nopanel

...

=true}|
|[Open(System.IO.Stream)

...

|ExcelApplication.Open(System.IO.Stream)

...

]|{excerpt-include:ExcelApplication.Open(System.IO.Stream)

...

|nopanel

...

=true}|
|[Open(System.IO.Stream, String)

...

|ExcelApplication.Open(System.IO.Stream, String)

...

]|{excerpt-include:ExcelApplication.Open(System.IO.Stream, String)

...

|nopanel

...

=true}|
|[Save(Workbook, String)

...

|ExcelApplication.Save(Workbook, String)

...

]|{excerpt-include:ExcelApplication.Save(Workbook, String)

...

|nopanel

...

=true}|
|[Save(Workbook, System.IO.Stream)

...

|ExcelApplication.Save(Workbook, System.IO.Stream)

...

]|{excerpt-include:ExcelApplication.Save(Workbook, System.IO.Stream)

...

|nopanel

...

=true}|
|[Save(Workbook, System.Web.HttpResponse, String, Boolean)

...

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

...

]|{excerpt-include:ExcelApplication.Save(Workbook, System.Web.HttpResponse, String, Boolean)

...

|nopanel

...

=true}|
|[Save(Workbook, System.Web.HttpResponse, String, Boolean, String)

...

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

...

]|{excerpt-include:ExcelApplication.Save(Workbook, System.Web.HttpResponse, String, Boolean, String)

...

|nopanel

...

=true}|
|[SaveToStream(Workbook)

...

|ExcelApplication.SaveToStream(Workbook)

...

]|{excerpt-include:ExcelApplication.SaveToStream(Workbook)

...

|nopanel

...

Classes

...

Name

...

Description

...

FileFormat

...

Extensionmethods

...

Overload

...

Description

=true}|

{classes}
||Name||Description||
|[FileFormat|ExcelApplication.FileFormat]|{excerpt-include:ExcelApplication.FileFormat|nopanel=true}|

{extensionMethods}
{introducedin:7.5}
||Overload||Description||
|[Open(Microsoft.SharePoint.SPDocumentLibrary, String)

...

|SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String)

...

]|{excerpt-include:SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPDocumentLibrary, String)

...

|nopanel

...

=true}|
|[Open(Microsoft.SharePoint.SPListItem, String)

...

|SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String)

...

]|{excerpt-include:SharePointIntegration.Open(ExcelApplication, Microsoft.SharePoint.SPListItem, String)

...

|nopanel

...

=true}|
|[Save(Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)

...

|SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)

...

]|{excerpt-include:SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)

...

|nopanel

...

=true}|
|[Save(Workbook, Microsoft.SharePoint.SPListItem, String)

...

|SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String)

...

]|{excerpt-include:SharePointIntegration.Save(ExcelApplication, Workbook, Microsoft.SharePoint.SPListItem, String)

...

|nopanel

...

=true}|