MailMerge Class |
Represents a class for performing mail merge operations.
Inheritance Hierarchy
System
Object
Spire.Doc.Reporting MailMerge
Spire.Doc.Reporting MailMerge
Namespace: Spire.Doc.Reporting
Assembly: Spire.Doc (in Spire.Doc.dll) Version: 13.2.3.0 (13.2.3.3046)
Syntax
The MailMerge type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
ClearFields |
Gets or sets a value indicating whether [clear fields]. by default value is true.
|
|
|
ClearGroupTag |
Gets or sets a value indicating whether [clear group tag]. by default value is false.
|
|
Document | |
|
|
HideEmptyGroup |
Gets or sets a value indicating whether to remove groups which contain empty merge fields
|
|
|
HideEmptyParagraphs |
Gets or sets a value indicating whether to remove paragraphs which contain empty merge fields
|
|
|
MailMergeMainDocumentType |
Specifies the possible types for a mail merge source document.
|
|
|
MappedFields |
Gets the collection of mapped fields. Mapped fields represent mapping between
fields names in the data source and mail merge fields in the document. The keys of
the collection are merge field names and the values are field names in the data source.
|
Methods
| Name | Description | |
|---|---|---|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Execute(IEnumerable) |
Performs mail merge operation.
|
|
|
Execute(DataRow) |
Performs mail merge from a DataRow into the document
|
|
|
Execute(DataTable) |
Performs mail merge from a DataTable
|
|
|
Execute(DataView) |
Performs mail merge from a DataView
|
|
|
Execute(IDataReader) |
Performs mail merge from a DataView
|
|
|
Execute(OleDbDataReader) |
Performs mail merge from
|
|
|
Execute( String , String ) |
Performs mail merge operation.
|
|
|
ExecuteGroup |
Performs mail merge operation.
|
|
|
ExecuteWidthNestedRegion(DbConnection, List DictionaryEntry ) |
Executes nested mailmerge within a region for the specified data.
|
|
|
ExecuteWidthNestedRegion(DataSet, List DictionaryEntry ) |
Executes the nested region.
|
|
|
ExecuteWidthNestedRegion(MailMergeDataSet, List DictionaryEntry ) |
Performs mail merge operation.
|
|
|
ExecuteWidthNestedRegion(DbConnection, List DictionaryEntry , Boolean) |
Executes the nested region.
|
|
|
ExecuteWidthRegion(DataTable) |
Performs Mail Merge within a region from a DataTable.
|
|
|
ExecuteWidthRegion(DataView) |
Performs Mail Merge within a region from a DataView.
|
|
|
ExecuteWidthRegion(IDataReader) |
Performs Mail Merge within a region from a DataReader.
|
|
Finalize |
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from
Object
.)
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetMergeFieldNames |
Returns a collection of mergefield names found in the document.
|
|
|
GetMergeFieldNames(String) |
Gets the merge field names.
|
|
|
GetMergeGroupNames |
Gets the merge field names.
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
SendMergeField | |
|
|
SendMergeGroup(GroupEventType, IRowsEnumerator) | |
|
|
SendMergeGroup(GroupEventType, IRowsEnumerator, IMergeField) | |
|
|
SendMergeImageField(IMergeField, Object, IRowsEnumerator) | |
|
|
SendMergeImageField(IMergeField, Object, String) | |
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
Events
| Name | Description | |
|---|---|---|
|
MergeField |
Occurs during mail merge when a text merge field processing.
|
|
|
MergeGroup |
Occurs during mail merge when group/table processing.
|
|
|
MergeImageField |
Occurs during mail merge when an image merge field processing.
|
See Also
