Page tree

Versions Compared

Key

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

Description

Excerpt

The WordTemplate object represents a WordWriter template. A WordWriter template is a file created in Microsoft Word that contains merge fields.

Signature
C#
C#

public sealed class WordTemplate
Signature
vb.net
vb.net

Public NotInheritable Class WordTemplate

...

Example

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

Code Block

<%@ Import Namespace="SoftArtisans.OfficeWriter.WordWriter" %>

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
titleC#

using SoftArtisans.OfficeWriter.WordWriter;
Code Block
vb.net
vb.net
titlevb.net

Imports SoftArtisans.OfficeWriter.WordWriter

To create an instance of the WordTemplate object use:

Code Block
csharp
csharp
titleC#

WordTemplate wt = new WordTemplate();
Code Block
vb.net
vb.net
titlevb.net

Dim wt As New WordTemplate()

Fields

ALL_ROWS

Excerpt Include
WordTemplate.ALL_ROWS
WordTemplate.ALL_ROWS
nopaneltrue

Properties

Name

Description

AllowURIs
Excerpt Include
WordTemplate.AllowURIs
WordTemplate.AllowURIs
nopaneltrue

Bookmarks

Excerpt Include
WordTemplate.Bookmarks
WordTemplate.Bookmarks
nopaneltrue

ContentType

Excerpt Include
WordTemplate.ContentType
WordTemplate.ContentType
nopaneltrue

CultureInfo

Excerpt Include
WordTemplate.CultureInfo
WordTemplate.CultureInfo
nopaneltrue

DataSourceSeparator

Excerpt Include
WordTemplate.DataSourceSeparator
WordTemplate.DataSourceSeparator
nopaneltrue

EnableNEXTFields

Excerpt Include
WordTemplate.EnableNEXTFields
WordTemplate.EnableNEXTFields
nopaneltrue

FieldMarkers

Excerpt Include
WordTemplate.FieldMarkers
WordTemplate.FieldMarkers
nopaneltrue

LicenseKey

Excerpt Include
WordTemplate.LicenseKey
WordTemplate.LicenseKey
nopaneltrue

PreserveFields

Excerpt Include
WordTemplate.PreserveFields
WordTemplate.PreserveFields
nopaneltrue

SaveExtension

Excerpt Include
WordTemplate.SaveExtension
WordTemplate.SaveExtension
nopaneltrue

UnlinkIfFields

Excerpt Include
WordTemplate.UnlinkIfFields
WordTemplate.UnlinkIfFields
nopaneltrue

UpdateIfFields

Excerpt Include
WordTemplate.UpdateIfFields
WordTemplate.UpdateIfFields
nopaneltrue

Version

Excerpt Include
WordTemplate.Version
WordTemplate.Version
nopaneltrue

Methods

Name

Description

BookmarkFieldMarkers(String)

Excerpt Include
WordTemplate.BookmarkFieldMarkers(String)
WordTemplate.BookmarkFieldMarkers(String)
nopaneltrue

Open(String)

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

Open(System.IO.Stream)

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

Open(WordApplication, Document)

Excerpt Include
WordTemplate.Open(WordApplication, Document)
WordTemplate.Open(WordApplication, Document)
nopaneltrue

Process()

Excerpt Include
WordTemplate.Process()
WordTemplate.Process()
nopaneltrue

Save(String)

Excerpt Include
WordTemplate.Save(String)
WordTemplate.Save(String)
nopaneltrue

Save(System.IO.Stream)

Excerpt Include
WordTemplate.Save(System.IO.Stream)
WordTemplate.Save(System.IO.Stream)
nopaneltrue

Save(System.Web.HttpResponse)

Excerpt Include
WordTemplate.Save(System.Web.HttpResponse)
WordTemplate.Save(System.Web.HttpResponse)
nopaneltrue

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

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

SetDataSource(Object(), String(), String)

Excerpt Include
WordTemplate.SetDataSource(Object(), String(), String)
WordTemplate.SetDataSource(Object(), String(), String)
nopaneltrue

SetDataSource(Object(), String())

Excerpt Include
WordTemplate.SetDataSource(Object(), String())
WordTemplate.SetDataSource(Object(), String())
nopaneltrue

SetDataSource(System.Data.DataSet, String)

Excerpt Include
WordTemplate.SetDataSource(System.Data.DataSet, String)
WordTemplate.SetDataSource(System.Data.DataSet, String)
nopaneltrue

SetDataSource(System.Data.DataSet)

Excerpt Include
WordTemplate.SetDataSource(System.Data.DataSet)
WordTemplate.SetDataSource(System.Data.DataSet)
nopaneltrue

SetDataSource(System.Data.DataTable, String)

Excerpt Include
WordTemplate.SetDataSource(System.Data.DataTable, String)
WordTemplate.SetDataSource(System.Data.DataTable, String)
nopaneltrue

SetDataSource(System.Data.DataTable)

Excerpt Include
WordTemplate.SetDataSource(System.Data.DataTable)
WordTemplate.SetDataSource(System.Data.DataTable)
nopaneltrue

SetDataSource(System.Data.IDataReader, String)

Excerpt Include
WordTemplate.SetDataSource(System.Data.IDataReader, String)
WordTemplate.SetDataSource(System.Data.IDataReader, String)
nopaneltrue

SetDataSource(System.Data.IDataReader)

Excerpt Include
WordTemplate.SetDataSource(System.Data.IDataReader)
WordTemplate.SetDataSource(System.Data.IDataReader)
nopaneltrue

SetDataSource(Object, String)

Excerpt Include
WordTemplate.SetDataSource(Object, String)
WordTemplate.SetDataSource(Object, String)
nopaneltrue

SetDataSource(System.Collections.IEnumerator, String())

Excerpt Include
WordTemplate.SetDataSource(System.Collections.IEnumerator, String())
WordTemplate.SetDataSource(System.Collections.IEnumerator, String())
nopaneltrue

SetDataSource(System.Collections.IEnumerator, String(), String)

Excerpt Include
WordTemplate.SetDataSource(System.Collections.IEnumerator, String(), String)
WordTemplate.SetDataSource(System.Collections.IEnumerator, String(), String)
nopaneltrue

SetDataSource(System.Collections.IDictionary)

Excerpt Include
WordTemplate.SetDataSource(System.Collections.IDictionary)
WordTemplate.SetDataSource(System.Collections.IDictionary)
nopaneltrue

SetDataSource(System.Collections.IDictionary, String)

Excerpt Include
WordTemplate.SetDataSource(System.Collections.IDictionary, String)
WordTemplate.SetDataSource(System.Collections.IDictionary, String)
nopaneltrue

SetDataSource(System.Collections.ICollection, String())

Excerpt Include
WordTemplate.SetDataSource(System.Collections.ICollection, String())
WordTemplate.SetDataSource(System.Collections.ICollection, String())
nopaneltrue

SetDataSource(System.Collections.ICollection, String(), String)

Excerpt Include
WordTemplate.SetDataSource(System.Collections.ICollection, String(), String)
WordTemplate.SetDataSource(System.Collections.ICollection, String(), String)
nopaneltrue

SetMailMerge(Object(,), String())

Excerpt Include
WordTemplate.SetMailMerge(Object(,), String())
WordTemplate.SetMailMerge(Object(,), String())
nopaneltrue

SetMailMerge(Object(,), String(), Int32, Boolean)

Excerpt Include
WordTemplate.SetMailMerge(Object(,), String(), Int32, Boolean)
WordTemplate.SetMailMerge(Object(,), String(), Int32, Boolean)
nopaneltrue

SetMailMerge(Object(), String())

Excerpt Include
WordTemplate.SetMailMerge(Object(), String())
WordTemplate.SetMailMerge(Object(), String())
nopaneltrue

SetMailMerge(Object()(), String())

Excerpt Include
WordTemplate.SetMailMerge(Object()(), String())
WordTemplate.SetMailMerge(Object()(), String())
nopaneltrue

SetMailMerge(Object()(), String(), Int32, Boolean)

Excerpt Include
WordTemplate.SetMailMerge(Object()(), String(), Int32, Boolean)
WordTemplate.SetMailMerge(Object()(), String(), Int32, Boolean)
nopaneltrue

SetMailMerge(System.Collections.ICollection)

Excerpt Include
WordTemplate.SetMailMerge(System.Collections.ICollection)
WordTemplate.SetMailMerge(System.Collections.ICollection)
nopaneltrue

SetMailMerge(System.Collections.IEnumerator)

Excerpt Include
WordTemplate.SetMailMerge(System.Collections.IEnumerator)
WordTemplate.SetMailMerge(System.Collections.IEnumerator)
nopaneltrue

SetMailMerge(System.Data.DataSet)

Excerpt Include
WordTemplate.SetMailMerge(System.Data.DataSet)
WordTemplate.SetMailMerge(System.Data.DataSet)
nopaneltrue

SetMailMerge(System.Data.DataSet, Int32)

Excerpt Include
WordTemplate.SetMailMerge(System.Data.DataSet, Int32)
WordTemplate.SetMailMerge(System.Data.DataSet, Int32)
nopaneltrue

SetMailMerge(System.Data.DataTable)

Excerpt Include
WordTemplate.SetMailMerge(System.Data.DataTable)
WordTemplate.SetMailMerge(System.Data.DataTable)
nopaneltrue

SetMailMerge(System.Data.DataTable, Int32)

Excerpt Include
WordTemplate.SetMailMerge(System.Data.DataTable, Int32)
WordTemplate.SetMailMerge(System.Data.DataTable, Int32)
nopaneltrue

SetMailMerge(System.Data.IDataReader)

Excerpt Include
WordTemplate.SetMailMerge(System.Data.IDataReader)
WordTemplate.SetMailMerge(System.Data.IDataReader)
nopaneltrue

SetMailMerge(System.Data.IDataReader, Int32)

Excerpt Include
WordTemplate.SetMailMerge(System.Data.IDataReader, Int32)
WordTemplate.SetMailMerge(System.Data.IDataReader, Int32)
nopaneltrue

SetRepeatBlock(System.Data.DataSet, String)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataSet, String)
WordTemplate.SetRepeatBlock(System.Data.DataSet, String)
nopaneltrue

SetRepeatBlock(System.Data.DataSet, String, Int32)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataSet, String, Int32)
WordTemplate.SetRepeatBlock(System.Data.DataSet, String, Int32)
nopaneltrue

SetRepeatBlock(System.Data.DataTable, String)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataTable, String)
WordTemplate.SetRepeatBlock(System.Data.DataTable, String)
nopaneltrue

SetRepeatBlock(System.Data.DataTable, String, Int32)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataTable, String, Int32)
WordTemplate.SetRepeatBlock(System.Data.DataTable, String, Int32)
nopaneltrue

SetRepeatBlock(System.Data.IDataReader, String)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.IDataReader, String)
WordTemplate.SetRepeatBlock(System.Data.IDataReader, String)
nopaneltrue

SetRepeatBlock(System.Data.IDataReader, String, Int32)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.IDataReader, String, Int32)
WordTemplate.SetRepeatBlock(System.Data.IDataReader, String, Int32)
nopaneltrue

SetRepeatBlock(Object(), String(), String)

Excerpt Include
WordTemplate.SetRepeatBlock(Object(), String(), String)
WordTemplate.SetRepeatBlock(Object(), String(), String)
nopaneltrue

SetRepeatBlock(Object(,), String(), String)

Excerpt Include
WordTemplate.SetRepeatBlock(Object(,), String(), String)
WordTemplate.SetRepeatBlock(Object(,), String(), String)
nopaneltrue

SetRepeatBlock(Object(,), String(), String, Int32, Boolean)

Excerpt Include
WordTemplate.SetRepeatBlock(Object(,), String(), String, Int32, Boolean)
WordTemplate.SetRepeatBlock(Object(,), String(), String, Int32, Boolean)
nopaneltrue

SetRepeatBlock(Object()(), String(), String)

Excerpt Include
WordTemplate.SetRepeatBlock(Object()(), String(), String)
WordTemplate.SetRepeatBlock(Object()(), String(), String)
nopaneltrue

SetRepeatBlock(Object()(), String(), String, Int32, Boolean)

Excerpt Include
WordTemplate.SetRepeatBlock(Object()(), String(), String, Int32, Boolean)
WordTemplate.SetRepeatBlock(Object()(), String(), String, Int32, Boolean)
nopaneltrue

SetRepeatBlock(System.Collections.IEnumerator, String)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String)
WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String)
nopaneltrue

SetRepeatBlock(System.Collections.IEnumerator, String, String)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String, String)
WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String, String)
nopaneltrue

SetRepeatBlock(System.Collections.ICollection, String)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.ICollection, String)
WordTemplate.SetRepeatBlock(System.Collections.ICollection, String)
nopaneltrue

SetRepeatBlock(System.Collections.ICollection, String, String)

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.ICollection, String, String)
WordTemplate.SetRepeatBlock(System.Collections.ICollection, String, String)
nopaneltrue

WordTemplate()

Excerpt Include
WordTemplate.WordTemplate()
WordTemplate.WordTemplate()
nopaneltrue

Extensionmethods
Introducedin
4.5
4.5

Overload

Description

Open(Microsoft.SharePoint.SPDocumentLibrary, String)

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

Open(Microsoft.SharePoint.SPListItem, String)

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

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

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

Save(Microsoft.SharePoint.SPListItem, String)

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

SetDataSource(Microsoft.SharePoint.SPList, String)

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList, String)
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList, String)
nopaneltrue

SetDataSource(Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList)
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList)
nopaneltrue

SetDataSource(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String)

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String)
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String)
nopaneltrue

SetDataSource(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
nopaneltrue

SetMailMerge(Microsoft.SharePoint.SPList, Int32)

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList, Int32)
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList, Int32)
nopaneltrue

SetMailMerge(Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList)
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList)
nopaneltrue

SetMailMerge(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Int32)

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Int32)
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Int32)
nopaneltrue

SetMailMerge(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList)
nopaneltrue

SetRepeatBlock(Microsoft.SharePoint.SPList, String, Int32)

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String, Int32)
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String, Int32)
nopaneltrue

SetRepeatBlock(Microsoft.SharePoint.SPList, String)

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String)
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String)
nopaneltrue

SetRepeatBlock(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int32)

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int32)
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int32)
nopaneltrue

SetRepeatBlock(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String)

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String)
SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String)
nopaneltrue