.
| 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# | |||||||
|---|---|---|---|---|---|---|---|---|---|
| Wiki Markup | |||||||||
{description}
{excerpt}The WordTemplate object represents a WordWriter template. A WordWriter template is a file created in Microsoft Word that contains merge fields.{excerpt}
{signature:C#}
public sealed class WordTemplate
| |||||||||
| Signature | |||||||||
{signature}{signature:vb.net | vb.net | }
Public NotInheritable Class WordTemplate
| |||||||
| Remarks | |||||||||
The WordTemplate object is in the {signature} {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. | |||||||||
| Example | |||||||||
If you are coding directly in the .aspx page, following the Page directive, include: Code Block | {remarks} {example} If you are coding directly in the .aspx page, following the Page directive, include: {code} <%@ 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 :csharp | csharp | |||||||
| Code Block | vb.net | title | csharp | ||||||
| Code Block | vb.net | title |
| Fields |
|---|
{code} {example} {fields} | [ALL_ROWS |
...
|WordTemplate.ALL_ROWS |
...
] | {excerpt-include:WordTemplate.ALL_ROWS |
...
|nopanel |
...
| Properties |
|---|
...
Name
...
Description
...
...
...
...
...
...
...
...
...
...
...
...
| Methods |
|---|
...
Name
...
Description
...
...
...
=true} | {properties} || Name || Description || | [Bookmarks|WordTemplate.Bookmarks] | {excerpt-include:WordTemplate.Bookmarks|nopanel=true} | | [ContentType|WordTemplate.ContentType] | {excerpt-include:WordTemplate.ContentType|nopanel=true} | | [CultureInfo|WordTemplate.CultureInfo] | {excerpt-include:WordTemplate.CultureInfo|nopanel=true} | | [DataSourceSeparator|WordTemplate.DataSourceSeparator] | {excerpt-include:WordTemplate.DataSourceSeparator|nopanel=true} | | [EnableNEXTFields|WordTemplate.EnableNEXTFields] | {excerpt-include:WordTemplate.EnableNEXTFields|nopanel=true} | | [FieldMarkers|WordTemplate.FieldMarkers] | {excerpt-include:WordTemplate.FieldMarkers|nopanel=true} | | [LicenseKey|WordTemplate.LicenseKey] | {excerpt-include:WordTemplate.LicenseKey|nopanel=true} | | [PreserveFields|WordTemplate.PreserveFields] | {excerpt-include:WordTemplate.PreserveFields|nopanel=true} | | [SaveExtension|WordTemplate.SaveExtension] | {excerpt-include:WordTemplate.SaveExtension|nopanel=true} | | [UnlinkIfFields|WordTemplate.UnlinkIfFields] | {exerpt-include:WordTemplate.UnlinkIfFields|nopanel=true}| | [UpdateIfFields|WordTemplate.UpdateIfFields] | {excerpt-include:WordTemplate.UpdateIfFields|nopanel=true} | | [Version|WordTemplate.Version] | {excerpt-include:WordTemplate.Version|nopanel=true} | {methods} || Name || Description || | [BookmarkFieldMarkers(String)|WordTemplate.BookmarkFieldMarkers(String)] | {excerpt-include:WordTemplate.BookmarkFieldMarkers(String)|nopanel=true} | | [Open(String)|WordTemplate.Open(String)] | {excerpt-include:WordTemplate.Open(String)|nopanel=true} | | [Open(System.IO.Stream) |
...
|WordTemplate.Open(System.IO.Stream) |
...
] | {excerpt-include:WordTemplate.Open(System.IO.Stream) |
...
|nopanel |
...
=true} | | [Open(WordApplication, Document) |
...
|WordTemplate.Open(WordApplication, Document) |
...
] | {excerpt-include:WordTemplate.Open(WordApplication, Document) |
...
|nopanel |
...
=true} | | [Process() |
...
|WordTemplate.Process() |
...
] | {excerpt-include:WordTemplate.Process() |
...
|nopanel |
...
=true} | | [Save(String) |
...
|WordTemplate.Save(String) |
...
] | {excerpt-include:WordTemplate.Save(String) |
...
|nopanel |
...
=true} | | [Save(System.IO.Stream) |
...
|WordTemplate.Save(System.IO.Stream) |
...
] | {excerpt-include:WordTemplate.Save(System.IO.Stream) |
...
|nopanel |
...
=true} | | [Save(System.Web.HttpResponse) |
...
|WordTemplate.Save(System.Web.HttpResponse) |
...
] | {excerpt-include:WordTemplate.Save(System.Web.HttpResponse) |
...
|nopanel |
...
=true} | | [Save(System.Web.HttpResponse, String, Boolean) |
...
|WordTemplate.Save(System.Web.HttpResponse, String, Boolean) |
...
] | {excerpt-include:WordTemplate.Save(System.Web.HttpResponse, String, Boolean) |
...
|nopanel |
...
=true} | | [SetDataSource(Object(), String(), String) |
...
|WordTemplate.SetDataSource(Object(), String(), String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(Object(), String(), String) |
...
|nopanel |
...
=true} | | [SetDataSource(Object(), String()) |
...
|WordTemplate.SetDataSource(Object(), String()) |
...
] | {excerpt-include:WordTemplate.SetDataSource(Object(), String()) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Data.DataSet, String) |
...
|WordTemplate.SetDataSource(System.Data.DataSet, String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Data.DataSet, String) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Data.DataSet) |
...
|WordTemplate.SetDataSource(System.Data.DataSet) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Data.DataSet) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Data.DataTable, String) |
...
|WordTemplate.SetDataSource(System.Data.DataTable, String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Data.DataTable, String) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Data.DataTable) |
...
|WordTemplate.SetDataSource(System.Data.DataTable) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Data.DataTable) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Data.IDataReader, String) |
...
|WordTemplate.SetDataSource(System.Data.IDataReader, String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Data.IDataReader, String) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Data.IDataReader) |
...
|WordTemplate.SetDataSource(System.Data.IDataReader) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Data.IDataReader) |
...
|nopanel |
...
=true} | | [SetDataSource(Object, String) |
...
|WordTemplate.SetDataSource(Object, String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(Object, String) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Collections.IEnumerator, String()) |
...
|WordTemplate.SetDataSource(System.Collections.IEnumerator, String()) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Collections.IEnumerator, String()) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Collections.IEnumerator, String(), String) |
...
|WordTemplate.SetDataSource(System.Collections.IEnumerator, String(), String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Collections.IEnumerator, String(), String) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Collections.IDictionary) |
...
|WordTemplate.SetDataSource(System.Collections.IDictionary) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Collections.IDictionary) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Collections.IDictionary, String) |
...
|WordTemplate.SetDataSource(System.Collections.IDictionary, String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Collections.IDictionary, String) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Collections.ICollection, String()) |
...
|WordTemplate.SetDataSource(System.Collections.ICollection, String()) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Collections.ICollection, String()) |
...
|nopanel |
...
=true} | | [SetDataSource(System.Collections.ICollection, String(), String) |
...
|WordTemplate.SetDataSource(System.Collections.ICollection, String(), String) |
...
] | {excerpt-include:WordTemplate.SetDataSource(System.Collections.ICollection, String(), String) |
...
|nopanel |
...
=true} | | [SetMailMerge(Object(,), String()) |
...
|WordTemplate.SetMailMerge(Object(,), String()) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(Object(,), String()) |
...
|nopanel |
...
=true} | | [SetMailMerge(Object(,), String(), Int32, Boolean) |
...
|WordTemplate.SetMailMerge(Object(,), String(), Int32, Boolean) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(Object(,), String(), Int32, Boolean) |
...
|nopanel |
...
=true} | | [SetMailMerge(Object(), String()) |
...
|WordTemplate.SetMailMerge(Object(), String()) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(Object(), String()) |
...
|nopanel |
...
=true} | | [SetMailMerge(Object()(), String()) |
...
|WordTemplate.SetMailMerge(Object()(), String()) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(Object()(), String()) |
...
|nopanel |
...
=true} | | [SetMailMerge(Object()(), String(), Int32, Boolean) |
...
|WordTemplate.SetMailMerge(Object()(), String(), Int32, Boolean) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(Object()(), String(), Int32, Boolean) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Collections.ICollection) |
...
|WordTemplate.SetMailMerge(System.Collections.ICollection) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Collections.ICollection) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Collections.IEnumerator) |
...
|WordTemplate.SetMailMerge(System.Collections.IEnumerator) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Collections.IEnumerator) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Data.DataSet) |
...
|WordTemplate.SetMailMerge(System.Data.DataSet) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Data.DataSet) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Data.DataSet, Int32) |
...
|WordTemplate.SetMailMerge(System.Data.DataSet, Int32) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Data.DataSet, Int32) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Data.DataTable) |
...
|WordTemplate.SetMailMerge(System.Data.DataTable) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Data.DataTable) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Data.DataTable, Int32) |
...
|WordTemplate.SetMailMerge(System.Data.DataTable, Int32) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Data.DataTable, Int32) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Data.IDataReader) |
...
|WordTemplate.SetMailMerge(System.Data.IDataReader) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Data.IDataReader) |
...
|nopanel |
...
=true} | | [SetMailMerge(System.Data.IDataReader, Int32) |
...
|WordTemplate.SetMailMerge(System.Data.IDataReader, Int32) |
...
] | {excerpt-include:WordTemplate.SetMailMerge(System.Data.IDataReader, Int32) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Data.DataSet, String) |
...
|WordTemplate.SetRepeatBlock(System.Data.DataSet, String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Data.DataSet, String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Data.DataSet, String, Int32) |
...
|WordTemplate.SetRepeatBlock(System.Data.DataSet, String, Int32) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Data.DataSet, String, Int32) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Data.DataTable, String) |
...
|WordTemplate.SetRepeatBlock(System.Data.DataTable, String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Data.DataTable, String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Data.DataTable, String, Int32) |
...
|WordTemplate.SetRepeatBlock(System.Data.DataTable, String, Int32) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Data.DataTable, String, Int32) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Data.IDataReader, String) |
...
|WordTemplate.SetRepeatBlock(System.Data.IDataReader, String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Data.IDataReader, String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Data.IDataReader, String, Int32) |
...
|WordTemplate.SetRepeatBlock(System.Data.IDataReader, String, Int32) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Data.IDataReader, String, Int32) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(Object(), String(), String) |
...
|WordTemplate.SetRepeatBlock(Object(), String(), String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(Object(), String(), String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(Object(,), String(), String) |
...
|WordTemplate.SetRepeatBlock(Object(,), String(), String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(Object(,), String(), String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(Object(,), String(), String, Int32, Boolean) |
...
|WordTemplate.SetRepeatBlock(Object(,), String(), String, Int32, Boolean) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(Object(,), String(), String, Int32, Boolean) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(Object()(), String(), String) |
...
|WordTemplate.SetRepeatBlock(Object()(), String(), String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(Object()(), String(), String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(Object()(), String(), String, Int32, Boolean) |
...
|WordTemplate.SetRepeatBlock(Object()(), String(), String, Int32, Boolean) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(Object()(), String(), String, Int32, Boolean) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Collections.IEnumerator, String) |
...
|WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Collections.IEnumerator, String, String) |
...
|WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String, String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Collections.IEnumerator, String, String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Collections.ICollection, String) |
...
|WordTemplate.SetRepeatBlock(System.Collections.ICollection, String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Collections.ICollection, String) |
...
|nopanel |
...
=true} | | [SetRepeatBlock(System.Collections.ICollection, String, String) |
...
|WordTemplate.SetRepeatBlock(System.Collections.ICollection, String, String) |
...
] | {excerpt-include:WordTemplate.SetRepeatBlock(System.Collections.ICollection, String, String) |
...
|nopanel |
...
=true} | | [WordTemplate() |
...
|WordTemplate.WordTemplate() |
...
] | {excerpt-include:WordTemplate.WordTemplate() |
...
|nopanel |
...
| Extensionmethods |
|---|
...
Overload
...
Description
=true} | {extensionMethods} {introducedin:4.5} ||Overload||Description|| |[Open(Microsoft.SharePoint.SPDocumentLibrary, String) |
...
|SharePointIntegration.Open(WordTemplate, Microsoft.SharePoint.SPDocumentLibrary, String) |
...
]|{excerpt-include:SharePointIntegration.Open(WordTemplate, Microsoft.SharePoint.SPDocumentLibrary, String) |
...
|nopanel |
...
=true}| |[Open(Microsoft.SharePoint.SPListItem, String) |
...
|SharePointIntegration.Open(WordTemplate, Microsoft.SharePoint.SPListItem, String) |
...
]|{excerpt-include:SharePointIntegration.Open(WordTemplate, Microsoft.SharePoint.SPListItem, String) |
...
|nopanel |
...
=true}| |[Save(Microsoft.SharePoint.SPDocumentLibrary, String, Boolean) |
...
|SharePointIntegration.Save(WordTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean) |
...
]|{excerpt-include:SharePointIntegration.Save(WordTemplate, Microsoft.SharePoint.SPDocumentLibrary, String, Boolean) |
...
|nopanel |
...
=true}| |[Save(Microsoft.SharePoint.SPListItem, String) |
...
|SharePointIntegration.Save(WordTemplate, Microsoft.SharePoint.SPListItem, String) |
...
]|{excerpt-include:SharePointIntegration.Save(WordTemplate, Microsoft.SharePoint.SPListItem, String) |
...
|nopanel |
...
=true}| |[SetDataSource(Microsoft.SharePoint.SPList, String) |
...
|SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList, String) |
...
]|{excerpt-include:SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList, String) |
...
|nopanel |
...
=true}| |[SetDataSource(Microsoft.SharePoint.SPList) |
...
|SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList) |
...
]|{excerpt-include:SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPList) |
...
|nopanel |
...
=true}| |[SetDataSource(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
...
|SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
...
]|{excerpt-include:SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
...
|nopanel |
...
=true}| |[SetDataSource(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
...
|SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
...
]|{excerpt-include:SharePointIntegration.SetDataSource(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
...
|nopanel |
...
=true}| |[SetMailMerge(Microsoft.SharePoint.SPList, Int32) |
...
|SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList, Int32) |
...
]|{excerpt-include:SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList, Int32) |
...
|nopanel |
...
=true}| |[SetMailMerge(Microsoft.SharePoint.SPList) |
...
|SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList) |
...
]|{excerpt-include:SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPList) |
...
|nopanel |
...
=true}| |[SetMailMerge(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Int32) |
...
|SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Int32) |
...
]|{excerpt-include:SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, Int32) |
...
|nopanel |
...
=true}| |[SetMailMerge(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
...
|SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
...
]|{excerpt-include:SharePointIntegration.SetMailMerge(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList) |
...
|nopanel |
...
=true}| |[SetRepeatBlock(Microsoft.SharePoint.SPList, String, Int32) |
...
|SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String, Int32) |
...
]|{excerpt-include:SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String, Int32) |
...
|nopanel |
...
=true}| |[SetRepeatBlock(Microsoft.SharePoint.SPList, String) |
...
|SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String) |
...
]|{excerpt-include:SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPList, String) |
...
|nopanel |
...
=true}| |[SetRepeatBlock(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int32) |
...
|SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int32) |
...
]|{excerpt-include:SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String, Int32) |
...
|nopanel |
...
=true}| |[SetRepeatBlock(Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
...
|SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
...
]|{excerpt-include:SharePointIntegration.SetRepeatBlock(WordTemplate, Microsoft.SharePoint.SPView, Microsoft.SharePoint.SPList, String) |
...
|nopanel |
...
=true}| |