Page tree

Versions Compared

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

The ExcelTemplate object represents an ExcelWriter template spreadsheet.

Signature
C#
C#
public class ExcelTemplate
{signature}{signature:
}
Signature
vb.net
vb.net
Public Class ExcelTemplate
{signature}
{remarks}
An ExcelWriter template is a file created in Microsoft Excel that contains data markers.

A data marker specifies a database column, variable, or array to insert in the spreadsheet column containing the marker.

The {{ExcelTemplate}} object is in the {{SoftArtisans.OfficeWriter.ExcelWriter}} namespace. The object can be referenced as {{
Remarks

An ExcelWriter template is a file created in Microsoft Excel that contains data markers.

A data marker specifies a database column, variable, or array to insert in the spreadsheet column containing the marker.

The ExcelTemplate object is in the SoftArtisans.OfficeWriter.ExcelWriter namespace. The object can be referenced as SoftArtisans.OfficeWriter.ExcelWriter.ExcelTemplate

}}

.

To

minimize

typing

and

errors,

use

an

{{

Import

}}

directive

to

import

the

namespace

to

the

aspx

page,

and

reference

the

object

as

{{

ExcelTemplate

}}

,

without

the

namespace

prefix.

{remarks} {example}If you are coding directly in the .aspx page, following the Page directive, include: {code}

Example

If you are coding directly in the .aspx page, following the Page directive, include:

Code Block

<%@ Import Namespace="SoftArtisans.OfficeWriter.ExcelWriter" %>
{code}

If

you

are

coding

in

the

"code

behind"

page

\

(.aspx.vb

or

.aspx.cs

\

),

include

an

{{

Imports

}}

or

{{

using

}}

statement

at

the

top

of

the

"code

behind"

page:

{

Code Block
:
csharp
|
csharp
title
=
C#
}

using SoftArtisans.OfficeWriter.ExcelWriter;
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}

Imports SoftArtisans.OfficeWriter.ExcelWriter
{code}

To

create

an

instance

of

the

{{

ExcelTemplate

}}

object

use:

{

Code Block
:
csharp
|
csharp
title
=
C#
}

ExcelTemplate oExcelTemplate = new ExcelTemplate();
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}

Dim oExcelTemplate As New ExcelTemplate()
{code} {example} {fields} | [
Fields

...

Excerpt Include
ExcelTemplate.ALL_ROWS

...

ExcelTemplate.ALL_ROWS

...

nopanel

...

true
Properties

Name

Description

ContentType

Excerpt Include
ExcelTemplate.ContentType
ExcelTemplate.ContentType
nopaneltrue

DecryptPassword

Excerpt Include
ExcelTemplate.DecryptPassword
ExcelTemplate.DecryptPassword
nopaneltrue

EncryptPassword

Excerpt Include
ExcelTemplate.EncryptPassword
ExcelTemplate.EncryptPassword
nopaneltrue

ExcludeMacros

Excerpt Include
ExcelTemplate.ExcludeMacros
ExcelTemplate.ExcludeMacros
nopaneltrue

LicenseKey

Excerpt Include
ExcelTemplate.LicenseKey
ExcelTemplate.LicenseKey
nopaneltrue

PreserveStrings

Excerpt Include
ExcelTemplate.PreserveStrings
ExcelTemplate.PreserveStrings
nopaneltrue

RemoveExtraDataMarkers

Excerpt Include
ExcelTemplate.RemoveExtraDataMarkers
ExcelTemplate.RemoveExtraDataMarkers
nopaneltrue

StretchCellReferencesInCharts

Excerpt Include
ExcelTemplate.StretchCellReferencesInCharts
ExcelTemplate.StretchCellReferencesInCharts
nopaneltrue

Version

Excerpt Include
ExcelTemplate.Version
ExcelTemplate.Version
nopaneltrue
Methods

Name

Description

BindCellData(Object, String, DataBindingProperties)

Excerpt Include
ExcelTemplate.BindCellData(Object, String, DataBindingProperties)
ExcelTemplate.BindCellData(Object, String, DataBindingProperties)
nopaneltrue

BindColumnData(Object(), String, DataBindingProperties)

Excerpt Include
ExcelTemplate.BindColumnData(Object(),

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindColumnData(Object(),

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindColumnData(System.Collections.IDictionary,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindColumnData(System.Collections.IDictionary,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindColumnData(System.Collections.IEnumerable,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindColumnData(System.Collections.IEnumerable,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

...

Excerpt Include
ExcelTemplate.BindData(Object()(),

...

String(),

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindData(Object()(),

...

String(),

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

...

Excerpt Include
ExcelTemplate.BindData(Object(,),

...

String(),

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindData(Object(,),

...

String(),

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindData(System.Data.IDataReader,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindData(System.Data.IDataReader,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindData(System.Data.DataSet,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindData(System.Data.DataSet,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindData(System.Data.DataTable,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindData(System.Data.DataTable,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

...

Excerpt Include
ExcelTemplate.BindRowData(Object(),

...

String(),

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindRowData(Object(),

...

String(),

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindRowData(System.Collections.IDictionary,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindRowData(System.Collections.IDictionary,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

...

Excerpt Include
ExcelTemplate.BindRowData(System.Collections.IEnumerable,

...

String(),

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindRowData(System.Collections.IEnumerable,

...

String(),

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindRowData(System.Data.DataSet,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindRowData(System.Data.DataSet,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindRowData(System.Data.DataTable,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindRowData(System.Data.DataTable,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.BindRowData(System.Data.DataView,

...

String,

...

DataBindingProperties)

...

ExcelTemplate.BindRowData(System.Data.DataView,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

Excerpt Include
ExcelTemplate.CreateDataBindingProperties()

...

ExcelTemplate.CreateDataBindingProperties()

...

nopanel

...

...

Excerpt Include
ExcelTemplate.ExcelTemplate()

...

ExcelTemplate.ExcelTemplate()

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.Open(ExcelApplication,

...

Workbook)

...

ExcelTemplate.Open(ExcelApplication,

...

Workbook)

...

nopanel

...

...

Excerpt Include
ExcelTemplate.Open(String)

...

ExcelTemplate.Open(String)

...

nopanel

...

...

Excerpt Include
ExcelTemplate.Open(System.IO.Stream)

...

ExcelTemplate.Open(System.IO.Stream)

...

nopanel

...

...

Excerpt Include
ExcelTemplate.Process()

...

ExcelTemplate.Process()

...

nopanel

...

...

Excerpt Include
ExcelTemplate.Save(String)

...

ExcelTemplate.Save(String)

...

nopanel

...

...

Excerpt Include
ExcelTemplate.Save(System.IO.Stream)

...

ExcelTemplate.Save(System.IO.Stream)

...

nopanel

...

...

Excerpt Include
ExcelTemplate.Save(System.Web.HttpResponse)

...

ExcelTemplate.Save(System.Web.HttpResponse)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.Save(System.Web.HttpResponse,

...

String,

...

Boolean)

...

ExcelTemplate.Save(System.Web.HttpResponse,

...

String,

...

Boolean)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetCellDataSource(Object,

...

String)

...

ExcelTemplate.SetCellDataSource(Object,

...

String)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetColumnDataSource(Object(),

...

String)

...

ExcelTemplate.SetColumnDataSource(Object(),

...

String)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetColumnDataSource(Object(),

...

String,

...

Int32)

...

ExcelTemplate.SetColumnDataSource(Object(),

...

String,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary,

...

String)

...

ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary,

...

String,

...

Int32)

...

ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary,

...

String,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable,

...

String)

...

ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable,

...

String,

...

Int32)

...

ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable,

...

String,

...

Int32)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(Object()(),

...

String(),

...

String)

...

ExcelTemplate.SetDataSource(Object()(),

...

String(),

...

String)

...

nopanel

...

...

...

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(Object()(),

...

String(),

...

String,

...

Int32,

...

Boolean)

...

ExcelTemplate.SetDataSource(Object()(),

...

String(),

...

String,

...

Int32,

...

Boolean)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(Object(,),

...

String(),

...

String)

...

ExcelTemplate.SetDataSource(Object(,),

...

String(),

...

String)

...

nopanel

...

...

...

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(Object(,),

...

String(),

...

String,

...

Int32,

...

Boolean)

...

ExcelTemplate.SetDataSource(Object(,),

...

String(),

...

String,

...

Int32,

...

Boolean)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(System.Data.IDataReader,

...

String)

...

ExcelTemplate.SetDataSource(System.Data.IDataReader,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(System.Data.IDataReader,

...

String,

...

Int32)

...

ExcelTemplate.SetDataSource(System.Data.IDataReader,

...

String,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(System.Data.DataSet,

...

String)

...

ExcelTemplate.SetDataSource(System.Data.DataSet,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(System.Data.DataSet,

...

String,

...

Int32)

...

ExcelTemplate.SetDataSource(System.Data.DataSet,

...

String,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(System.Data.DataTable,

...

String)

...

ExcelTemplate.SetDataSource(System.Data.DataTable,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetDataSource(System.Data.DataTable,

...

String,

...

Int32)

...

ExcelTemplate.SetDataSource(System.Data.DataTable,

...

String,

...

Int32)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetRowDataSource(Object(),

...

String(),

...

String)

...

ExcelTemplate.SetRowDataSource(Object(),

...

String(),

...

String)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetRowDataSource(System.Collections.IDictionary,

...

String)

...

ExcelTemplate.SetRowDataSource(System.Collections.IDictionary,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
ExcelTemplate.SetRowDataSource(System.Collections.IEnumerable,

...

String(),

...

String)

...

ExcelTemplate.SetRowDataSource(System.Collections.IEnumerable,

...

String(),

...

String)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetRowDataSource(System.Data.DataSet,

...

String)

...

ExcelTemplate.SetRowDataSource(System.Data.DataSet,

...

String)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetRowDataSource(System.Data.DataTable,

...

String)

...

ExcelTemplate.SetRowDataSource(System.Data.DataTable,

...

String)

...

nopanel

...

...

...

Excerpt Include
ExcelTemplate.SetRowDataSource(System.Data.DataView,

...

String)

...

ExcelTemplate.SetRowDataSource(System.Data.DataView,

...

String)

...

nopanel

...

true
Extensionmethods
Introducedin
7.5
7.5

...

...

...

...

Excerpt Include
SharePointIntegration.BindData(ExcelTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

SharePointIntegration.BindData(ExcelTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.BindData(ExcelTemplate,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

SharePointIntegration.BindData(ExcelTemplate,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

...

Excerpt Include
SharePointIntegration.BindRowData(ExcelTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

SharePointIntegration.BindRowData(ExcelTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.BindRowData(ExcelTemplate,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

SharePointIntegration.BindRowData(ExcelTemplate,

...

Microsoft.SharePoint.SPList,

...

String,

...

DataBindingProperties)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.Open(ExcelTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String)

...

SharePointIntegration.Open(ExcelTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.Open(ExcelTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

SharePointIntegration.Open(ExcelTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.Save(ExcelTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String,

...

Boolean)

...

SharePointIntegration.Save(ExcelTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String,

...

Boolean)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.Save(ExcelTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

SharePointIntegration.Save(ExcelTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

nopanel

...

true

...