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 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}{signature:
}
Signature
vb.net
vb.net
Public NotInheritable Class WordTemplate
{signature}
{remarks}The {{WordTemplate}} object is in the 
Remarks

The WordTemplate object is in the SoftArtisans.OfficeWriter.WordWriter

namespace.

The

object

can

be

referenced

as

{{

SoftArtisans.WordWriter.WordTemplate

}}

.

To

minimize

typing

and

errors,

import

the

namespace

to

the

aspx

page,

and

reference

the

object

as

{{

WordTemplate

}}

,

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.WordWriter" %>
{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.WordWriter;
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}

Imports SoftArtisans.OfficeWriter.WordWriter
{code}

To

create

an

instance

of

the

WordTemplate

object

use:

{

Code Block
:
csharp
|
csharp
title
=
C#
}

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

Dim wt As New WordTemplate()
{code} {example} {fields} | [
Fields

...

Excerpt Include
WordTemplate.ALL_ROWS

...

WordTemplate.ALL_ROWS

...

nopanel

...

true
Properties

Name

Description

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)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.Open(WordApplication,

...

Document)

...

WordTemplate.Open(WordApplication,

...

Document)

...

nopanel

...

...

Excerpt Include
WordTemplate.Process()

...

WordTemplate.Process()

...

nopanel

...

...

Excerpt Include
WordTemplate.Save(String)

...

WordTemplate.Save(String)

...

nopanel

...

...

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

...

WordTemplate.Save(System.IO.Stream)

...

nopanel

...

...

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

...

WordTemplate.Save(System.Web.HttpResponse)

...

nopanel

...

...

...

...

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

...

String,

...

Boolean)

...

WordTemplate.Save(System.Web.HttpResponse,

...

String,

...

Boolean)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetDataSource(Object(),

...

String(),

...

String)

...

WordTemplate.SetDataSource(Object(),

...

String(),

...

String)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetDataSource(Object(),

...

String())

...

WordTemplate.SetDataSource(Object(),

...

String())

...

nopanel

...

...

...

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

...

String)

...

WordTemplate.SetDataSource(System.Data.DataSet,

...

String)

...

nopanel

...

...

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

...

WordTemplate.SetDataSource(System.Data.DataSet)

...

nopanel

...

...

...

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

...

String)

...

WordTemplate.SetDataSource(System.Data.DataTable,

...

String)

...

nopanel

...

...

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

...

WordTemplate.SetDataSource(System.Data.DataTable)

...

nopanel

...

...

...

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

...

String)

...

WordTemplate.SetDataSource(System.Data.IDataReader,

...

String)

...

nopanel

...

...

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

...

WordTemplate.SetDataSource(System.Data.IDataReader)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetDataSource(Object,

...

String)

...

WordTemplate.SetDataSource(Object,

...

String)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetDataSource(System.Collections.IEnumerator,

...

String())

...

WordTemplate.SetDataSource(System.Collections.IEnumerator,

...

String())

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetDataSource(System.Collections.IEnumerator,

...

String(),

...

String)

...

WordTemplate.SetDataSource(System.Collections.IEnumerator,

...

String(),

...

String)

...

nopanel

...

...

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

...

WordTemplate.SetDataSource(System.Collections.IDictionary)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetDataSource(System.Collections.IDictionary,

...

String)

...

WordTemplate.SetDataSource(System.Collections.IDictionary,

...

String)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetDataSource(System.Collections.ICollection,

...

String())

...

WordTemplate.SetDataSource(System.Collections.ICollection,

...

String())

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetDataSource(System.Collections.ICollection,

...

String(),

...

String)

...

WordTemplate.SetDataSource(System.Collections.ICollection,

...

String(),

...

String)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetMailMerge(Object(,),

...

String())

...

WordTemplate.SetMailMerge(Object(,),

...

String())

...

nopanel

...

...

...

...

...

Excerpt Include
WordTemplate.SetMailMerge(Object(,),

...

String(),

...

Int32,

...

Boolean)

...

WordTemplate.SetMailMerge(Object(,),

...

String(),

...

Int32,

...

Boolean)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetMailMerge(Object(),

...

String())

...

WordTemplate.SetMailMerge(Object(),

...

String())

...

nopanel

...

...

...

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

...

String())

...

WordTemplate.SetMailMerge(Object()(),

...

String())

...

nopanel

...

...

...

...

...

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

...

String(),

...

Int32,

...

Boolean)

...

WordTemplate.SetMailMerge(Object()(),

...

String(),

...

Int32,

...

Boolean)

...

nopanel

...

...

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

...

WordTemplate.SetMailMerge(System.Collections.ICollection)

...

nopanel

...

...

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

...

WordTemplate.SetMailMerge(System.Collections.IEnumerator)

...

nopanel

...

...

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

...

WordTemplate.SetMailMerge(System.Data.DataSet)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetMailMerge(System.Data.DataSet,

...

Int32)

...

WordTemplate.SetMailMerge(System.Data.DataSet,

...

Int32)

...

nopanel

...

...

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

...

WordTemplate.SetMailMerge(System.Data.DataTable)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetMailMerge(System.Data.DataTable,

...

Int32)

...

WordTemplate.SetMailMerge(System.Data.DataTable,

...

Int32)

...

nopanel

...

...

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

...

WordTemplate.SetMailMerge(System.Data.IDataReader)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetMailMerge(System.Data.IDataReader,

...

Int32)

...

WordTemplate.SetMailMerge(System.Data.IDataReader,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataSet,

...

String)

...

WordTemplate.SetRepeatBlock(System.Data.DataSet,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataSet,

...

String,

...

Int32)

...

WordTemplate.SetRepeatBlock(System.Data.DataSet,

...

String,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataTable,

...

String)

...

WordTemplate.SetRepeatBlock(System.Data.DataTable,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.DataTable,

...

String,

...

Int32)

...

WordTemplate.SetRepeatBlock(System.Data.DataTable,

...

String,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.IDataReader,

...

String)

...

WordTemplate.SetRepeatBlock(System.Data.IDataReader,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Data.IDataReader,

...

String,

...

Int32)

...

WordTemplate.SetRepeatBlock(System.Data.IDataReader,

...

String,

...

Int32)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(Object(),

...

String(),

...

String)

...

WordTemplate.SetRepeatBlock(Object(),

...

String(),

...

String)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(Object(,),

...

String(),

...

String)

...

WordTemplate.SetRepeatBlock(Object(,),

...

String(),

...

String)

...

nopanel

...

...

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(Object(,),

...

String(),

...

String,

...

Int32,

...

Boolean)

...

WordTemplate.SetRepeatBlock(Object(,),

...

String(),

...

String,

...

Int32,

...

Boolean)

...

nopanel

...

...

...

...

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

...

String(),

...

String)

...

WordTemplate.SetRepeatBlock(Object()(),

...

String(),

...

String)

...

nopanel

...

...

...

...

...

...

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

...

String(),

...

String,

...

Int32,

...

Boolean)

...

WordTemplate.SetRepeatBlock(Object()(),

...

String(),

...

String,

...

Int32,

...

Boolean)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.IEnumerator,

...

String)

...

WordTemplate.SetRepeatBlock(System.Collections.IEnumerator,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.IEnumerator,

...

String,

...

String)

...

WordTemplate.SetRepeatBlock(System.Collections.IEnumerator,

...

String,

...

String)

...

nopanel

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.ICollection,

...

String)

...

WordTemplate.SetRepeatBlock(System.Collections.ICollection,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
WordTemplate.SetRepeatBlock(System.Collections.ICollection,

...

String,

...

String)

...

WordTemplate.SetRepeatBlock(System.Collections.ICollection,

...

String,

...

String)

...

nopanel

...

...

Excerpt Include
WordTemplate.WordTemplate()

...

WordTemplate.WordTemplate()

...

nopanel

...

true
Extensionmethods
Introducedin
4.5
4.5

...

...

Excerpt Include
SharePointIntegration.Open(WordTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String)

...

SharePointIntegration.Open(WordTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.Open(WordTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

SharePointIntegration.Open(WordTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.Save(WordTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String,

...

Boolean)

...

SharePointIntegration.Save(WordTemplate,

...

Microsoft.SharePoint.SPDocumentLibrary,

...

String,

...

Boolean)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.Save(WordTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

SharePointIntegration.Save(WordTemplate,

...

Microsoft.SharePoint.SPListItem,

...

String)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

String)

...

SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

String)

...

nopanel

...

...

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPList)

...

SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPList)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String)

...

SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList)

...

SharePointIntegration.SetDataSource(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

Int32)

...

SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

Int32)

...

nopanel

...

...

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPList)

...

SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPList)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

Int32)

...

SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList)

...

SharePointIntegration.SetMailMerge(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

String,

...

Int32)

...

SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

String,

...

Int32)

...

nopanel

...

...

...

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

String)

...

SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPList,

...

String)

...

nopanel

...

...

...

...

...

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String,

...

Int32)

...

SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String,

...

Int32)

...

nopanel

...

...

...

...

Excerpt Include
SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String)

...

SharePointIntegration.SetRepeatBlock(WordTemplate,

...

Microsoft.SharePoint.SPView,

...

Microsoft.SharePoint.SPList,

...

String)

...

nopanel

...

true

...