Page History

Wiki Markup
{description}
{excerpt}The [ExcelTemplate|ExcelTemplate] object represents an ExcelWriter template spreadsheet.
{excerpt}
{signature:C#}
public class ExcelTemplate
{signature}{signature: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 {{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}
<%@ 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:csharp|title=C#}
using SoftArtisans.OfficeWriter.ExcelWriter;{code}
{code:vb.net|title=vb.net}
Imports SoftArtisans.OfficeWriter.ExcelWriter{code}
To create an instance of the {{ExcelTemplate}} object use:{code:csharp|title=C#}
ExcelTemplate oExcelTemplate = new ExcelTemplate();{code}
{code:vb.net|title=vb.net}
Dim oExcelTemplate As New ExcelTemplate(){code}

{example}
{fields}
| [ALL_ROWS|ExcelTemplate.ALL_ROWS] | {excerpt-include:ExcelTemplate.ALL_ROWS|nopanel=true} |

{properties}
|| Name || Description ||
| [ContentType|ExcelTemplate.ContentType] | {excerpt-include:ExcelTemplate.ContentType|nopanel=true} |
| [DecryptPassword|ExcelTemplate.DecryptPassword] | {excerpt-include:ExcelTemplate.DecryptPassword|nopanel=true} |
| [EncryptPassword|ExcelTemplate.EncryptPassword] | {excerpt-include:ExcelTemplate.EncryptPassword|nopanel=true} |
| [ExcludeMacros|ExcelTemplate.ExcludeMacros] | {excerpt-include:ExcelTemplate.ExcludeMacros|nopanel=true} |
| [LicenseKey|ExcelTemplate.LicenseKey] | {excerpt-include:ExcelTemplate.LicenseKey|nopanel=true} |
| [PreserveStrings|ExcelTemplate.PreserveStrings] | {excerpt-include:ExcelTemplate.PreserveStrings|nopanel=true} |
| [RemoveExtraDataMarkers|ExcelTemplate.RemoveExtraDataMarkers] | {excerpt-include:ExcelTemplate.RemoveExtraDataMarkers|nopanel=true} |
| [StretchCellReferencesInCharts|ExcelTemplate.StretchCellReferencesInCharts] | {excerpt-include:ExcelTemplate.StretchCellReferencesInCharts|nopanel=true} |
| [Version|ExcelTemplate.Version] | {excerpt-include:ExcelTemplate.Version|nopanel=true} |
{methods}
|| Name || Description ||
| [BindCellData(Object, String, DataBindingProperties)|ExcelTemplate.BindCellData(Object, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindCellData(Object, String, DataBindingProperties)|nopanel=true} |
| [BindColumnData(Object(), String, DataBindingProperties)|ExcelTemplate.BindColumnData(Object(), String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindColumnData(Object(), String, DataBindingProperties)|nopanel=true} |
| [BindColumnData(System.Collections.IDictionary, String, DataBindingProperties)|ExcelTemplate.BindColumnData(System.Collections.IDictionary, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindColumnData(System.Collections.IDictionary, String, DataBindingProperties)|nopanel=true} |
| [BindColumnData(System.Collections.IEnumerable, String, DataBindingProperties)|ExcelTemplate.BindColumnData(System.Collections.IEnumerable, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindColumnData(System.Collections.IEnumerable, String, DataBindingProperties)|nopanel=true} |
| [BindData(Object()(), String(), String, DataBindingProperties)|ExcelTemplate.BindData(Object()(), String(), String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindData(Object()(), String(), String, DataBindingProperties)|nopanel=true} |
| [BindData(Object(,), String(), String, DataBindingProperties)|ExcelTemplate.BindData(Object(,), String(), String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindData(Object(,), String(), String, DataBindingProperties)|nopanel=true} |
| [BindData(System.Data.IDataReader, String, DataBindingProperties)|ExcelTemplate.BindData(System.Data.IDataReader, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindData(System.Data.IDataReader, String, DataBindingProperties)|nopanel=true} |
| [BindData(System.Data.DataSet, String, DataBindingProperties)|ExcelTemplate.BindData(System.Data.DataSet, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindData(System.Data.DataSet, String, DataBindingProperties)|nopanel=true} |
| [BindData(System.Data.DataTable, String, DataBindingProperties)|ExcelTemplate.BindData(System.Data.DataTable, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindData(System.Data.DataTable, String, DataBindingProperties)|nopanel=true} |
| [BindRowData(Object(), String(), String, DataBindingProperties)|ExcelTemplate.BindRowData(Object(), String(), String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindRowData(Object(), String(), String, DataBindingProperties)|nopanel=true} |
| [BindRowData(System.Collections.IDictionary, String, DataBindingProperties)|ExcelTemplate.BindRowData(System.Collections.IDictionary, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindRowData(System.Collections.IDictionary, String, DataBindingProperties)|nopanel=true} |
| [BindRowData(System.Collections.IEnumerable, String(), String, DataBindingProperties)|ExcelTemplate.BindRowData(System.Collections.IEnumerable, String(), String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindRowData(System.Collections.IEnumerable, String(), String, DataBindingProperties)|nopanel=true} |
| [BindRowData(System.Data.DataSet, String, DataBindingProperties)|ExcelTemplate.BindRowData(System.Data.DataSet, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindRowData(System.Data.DataSet, String, DataBindingProperties)|nopanel=true} |
| [BindRowData(System.Data.DataTable, String, DataBindingProperties)|ExcelTemplate.BindRowData(System.Data.DataTable, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindRowData(System.Data.DataTable, String, DataBindingProperties)|nopanel=true} |
| [BindRowData(System.Data.DataView, String, DataBindingProperties)|ExcelTemplate.BindRowData(System.Data.DataView, String, DataBindingProperties)] | {excerpt-include:ExcelTemplate.BindRowData(System.Data.DataView, String, DataBindingProperties)|nopanel=true} |
| [CreateDataBindingProperties()|ExcelTemplate.CreateDataBindingProperties()] | {excerpt-include:ExcelTemplate.CreateDataBindingProperties()|nopanel=true} |
| [ExcelTemplate()|ExcelTemplate.ExcelTemplate()] | {excerpt-include:ExcelTemplate.ExcelTemplate()|nopanel=true} |
| [Open(ExcelApplication, Workbook)|ExcelTemplate.Open(ExcelApplication, Workbook)] | {excerpt-include:ExcelTemplate.Open(ExcelApplication, Workbook)|nopanel=true} |
| [Open(String)|ExcelTemplate.Open(String)] | {excerpt-include:ExcelTemplate.Open(String)|nopanel=true} |
| [Open(System.IO.Stream)|ExcelTemplate.Open(System.IO.Stream)] | {excerpt-include:ExcelTemplate.Open(System.IO.Stream)|nopanel=true} |
| [Process()|ExcelTemplate.Process()] | {excerpt-include:ExcelTemplate.Process()|nopanel=true} |
| [Save(String)|ExcelTemplate.Save(String)] | {excerpt-include:ExcelTemplate.Save(String)|nopanel=true} |
| [Save(System.IO.Stream)|ExcelTemplate.Save(System.IO.Stream)] | {excerpt-include:ExcelTemplate.Save(System.IO.Stream)|nopanel=true} |
| [Save(System.Web.HttpResponse)|ExcelTemplate.Save(System.Web.HttpResponse)] | {excerpt-include:ExcelTemplate.Save(System.Web.HttpResponse)|nopanel=true} |
| [Save(System.Web.HttpResponse, String, Boolean)|ExcelTemplate.Save(System.Web.HttpResponse, String, Boolean)] | {excerpt-include:ExcelTemplate.Save(System.Web.HttpResponse, String, Boolean)|nopanel=true} |
| [SetCellDataSource(Object, String)|ExcelTemplate.SetCellDataSource(Object, String)] | {excerpt-include:ExcelTemplate.SetCellDataSource(Object, String)|nopanel=true} |
| [SetColumnDataSource(Object(), String)|ExcelTemplate.SetColumnDataSource(Object(), String)] | {excerpt-include:ExcelTemplate.SetColumnDataSource(Object(), String)|nopanel=true} |
| [SetColumnDataSource(Object(), String, Int32)|ExcelTemplate.SetColumnDataSource(Object(), String, Int32)] | {excerpt-include:ExcelTemplate.SetColumnDataSource(Object(), String, Int32)|nopanel=true} |
| [SetColumnDataSource(System.Collections.IDictionary, String)|ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary, String)] | {excerpt-include:ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary, String)|nopanel=true} |
| [SetColumnDataSource(System.Collections.IDictionary, String, Int32)|ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary, String, Int32)] | {excerpt-include:ExcelTemplate.SetColumnDataSource(System.Collections.IDictionary, String, Int32)|nopanel=true} |
| [SetColumnDataSource(System.Collections.IEnumerable, String)|ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable, String)] | {excerpt-include:ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable, String)|nopanel=true} |
| [SetColumnDataSource(System.Collections.IEnumerable, String, Int32)|ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable, String, Int32)] | {excerpt-include:ExcelTemplate.SetColumnDataSource(System.Collections.IEnumerable, String, Int32)|nopanel=true} |
| [SetDataSource(Object()(), String(), String)|ExcelTemplate.SetDataSource(Object()(), String(), String)] | {excerpt-include:ExcelTemplate.SetDataSource(Object()(), String(), String)|nopanel=true} |
| [SetDataSource(Object()(), String(), String, Int32, Boolean)|ExcelTemplate.SetDataSource(Object()(), String(), String, Int32, Boolean)] | {excerpt-include:ExcelTemplate.SetDataSource(Object()(), String(), String, Int32, Boolean)|nopanel=true} |
| [SetDataSource(Object(,), String(), String)|ExcelTemplate.SetDataSource(Object(,), String(), String)] | {excerpt-include:ExcelTemplate.SetDataSource(Object(,), String(), String)|nopanel=true} |
| [SetDataSource(Object(,), String(), String, Int32, Boolean)|ExcelTemplate.SetDataSource(Object(,), String(), String, Int32, Boolean)] | {excerpt-include:ExcelTemplate.SetDataSource(Object(,), String(), String, Int32, Boolean)|nopanel=true} |
| [SetDataSource(System.Data.IDataReader, String)|ExcelTemplate.SetDataSource(System.Data.IDataReader, String)] | {excerpt-include:ExcelTemplate.SetDataSource(System.Data.IDataReader, String)|nopanel=true} |
| [SetDataSource(System.Data.IDataReader, String, Int32)|ExcelTemplate.SetDataSource(System.Data.IDataReader, String, Int32)] | {excerpt-include:ExcelTemplate.SetDataSource(System.Data.IDataReader, String, Int32)|nopanel=true} |
| [SetDataSource(System.Data.DataSet, String)|ExcelTemplate.SetDataSource(System.Data.DataSet, String)] | {excerpt-include:ExcelTemplate.SetDataSource(System.Data.DataSet, String)|nopanel=true} |
| [SetDataSource(System.Data.DataSet, String, Int32)|ExcelTemplate.SetDataSource(System.Data.DataSet, String, Int32)] | {excerpt-include:ExcelTemplate.SetDataSource(System.Data.DataSet, String, Int32)|nopanel=true} |
| [SetDataSource(System.Data.DataTable, String)|ExcelTemplate.SetDataSource(System.Data.DataTable, String)] | {excerpt-include:ExcelTemplate.SetDataSource(System.Data.DataTable, String)|nopanel=true} |
| [SetDataSource(System.Data.DataTable, String, Int32)|ExcelTemplate.SetDataSource(System.Data.DataTable, String, Int32)] | {excerpt-include:ExcelTemplate.SetDataSource(System.Data.DataTable, String, Int32)|nopanel=true} |
| [SetRowDataSource(Object(), String(), String)|ExcelTemplate.SetRowDataSource(Object(), String(), String)] | {excerpt-include:ExcelTemplate.SetRowDataSource(Object(), String(), String)|nopanel=true} |
| [SetRowDataSource(System.Collections.IDictionary, String)|ExcelTemplate.SetRowDataSource(System.Collections.IDictionary, String)] | {excerpt-include:ExcelTemplate.SetRowDataSource(System.Collections.IDictionary, String)|nopanel=true} |
| [SetRowDataSource(System.Collections.IEnumerable, String(), String)|ExcelTemplate.SetRowDataSource(System.Collections.IEnumerable, String(), String)] | {excerpt-include:ExcelTemplate.SetRowDataSource(System.Collections.IEnumerable, String(), String)|nopanel=true} |
| [SetRowDataSource(System.Data.DataSet, String)|ExcelTemplate.SetRowDataSource(System.Data.DataSet, String)] | {excerpt-include:ExcelTemplate.SetRowDataSource(System.Data.DataSet, String)|nopanel=true} |
| [SetRowDataSource(System.Data.DataTable, String)|ExcelTemplate.SetRowDataSource(System.Data.DataTable, String)] | {excerpt-include:ExcelTemplate.SetRowDataSource(System.Data.DataTable, String)|nopanel=true} |
| [SetRowDataSource(System.Data.DataView, String)|ExcelTemplate.SetRowDataSource(System.Data.DataView, String)] | {excerpt-include:ExcelTemplate.SetRowDataSource(System.Data.DataView, String)|nopanel=true} |
{extensionMethods}
{introducedin:7.5}
|| Name || Description ||
|[BindData(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)|SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)]|{excerpt-include:SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)|nopanel=true}|
|[BindData(Microsoft.SharePoint.SPList, String, DataBindingProperties)|SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)]|{excerpt-include:SharePointIntegration.BindData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)|nopanel=true}|
|[BindRowData(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)|SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)]|{excerpt-include:SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, DataBindingProperties)|nopanel=true}|
|[BindRowData(Microsoft.SharePoint.SPList, String, DataBindingProperties)|SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)]|{excerpt-include:SharePointIntegration.BindRowData(ExcelTemplate, Microsoft.SharePoint.SPList, String, DataBindingProperties)|nopanel=true}|
|[Open(Microsoft.SharePoint.SPDocumentLibrary, String)|SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String)]|{excerpt-include:SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String)|nopanel=true}|
|[Open(Microsoft.SharePoint.SPListItem, String)|SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)]|{excerpt-include:SharePointIntegration.Open(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)|nopanel=true}|
|[Save(Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)|SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)]|{excerpt-include:SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean)|nopanel=true}|
|[Save(Microsoft.SharePoint.SPListItem, String)|SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)]|{excerpt-include:SharePointIntegration.Save(ExcelTemplate, Microsoft.SharePoint.SPListItem, String)|nopanel=true}|
Space Shortcuts

Page tree

Versions Compared

Old Version 5

New Version 6

Key
