Mail Merge

Classes

Class Description
TXTextControl.DocumentServer.MailMerge The MailMerge class is a .NET component that can be used to effortlessly merge template documents with database content in .NET projects, such as ASP.NET web applications, web services or Windows services.
TXTextControl.DocumentServer.MailMerge.BarcodeMergedEventArgs The BarcodeMergedEventArgs class provides data for the BarcodeMerged event.
TXTextControl.DocumentServer.MailMerge.BlockMergingEventArgs The BlockMergingEventArgs class provides data for the BlockMerging event.
TXTextControl.DocumentServer.MailMerge.BlockRowMergedEventArgs The BlockRowMergedEventArgs class provides data for the BlockRowMerged event.
TXTextControl.DocumentServer.MailMerge.ChartMergedEventArgs The ChartMergedEventArgs class provides data for the ChartMerged event.
TXTextControl.DocumentServer.MailMerge.DataRowMergedEventArgs The DataRowMergedEventArgs class provides data for the DataRowMerged event.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs The FieldMergedEventArgs class provides data for the FieldMerged event.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs The ImageFieldMergedEventArgs class provides data for the ImageFieldMerged event.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs The ImageMergedEventArgs class provides data for the ImageMerged event.
TXTextControl.DocumentServer.MailMerge.IncludeTextMergingEventArgs The IncludeTextMergingEventArgs class provides data for the IncludeTextMerging event.
TXTextControl.DocumentServer.MergeCanceledException A MergeCanceledException is thrown through the Merge method when the current merge process was canceled through the DataRowMergedEventArgs.Cancel property.
TXTextControl.DocumentServer.Json.InvalidNumberFormatException Is thrown when calling the method MailMerge.MergeJsonData with a JSON string containing a number with an invalid number format.
TXTextControl.DocumentServer.Json.UnexpectedTokenException Is thrown when calling the method MailMerge.MergeJsonData with a JSON string containing an unexpected character.
TXTextControl.DocumentServer.Json.ParserException Base class of all JSON parser related exceptions which can be thrown when calling method MailMerge.MergeJsonData with an incorrect JSON string.
TXTextControl.DocumentServer.Json.UnknownParseErrorException Is thrown when calling the method MailMerge.MergeJsonData and the internal JSON parser encounters an unknown error.
TXTextControl.DocumentServer.Json.UnknownLiteralNameTokenException Is thrown when calling the method MailMerge.MergeJsonData with a JSON string containing an unknown character sequence at a position where one of the strings "true", "false" or "null" are expected.
TXTextControl.DocumentServer.Json.InvalidCodePointException Is thrown when calling the method MailMerge.MergeJsonData with a JSON string containing an invalid hexadecimal unicode code point.
TXTextControl.DocumentServer.Json.UnexpectedEndOfInputException Is thrown when calling the method MailMerge.MergeJsonData with an incomplete JSON string.

Constructors

Constructor Description
TXTextControl.DocumentServer.MailMerge Initializes a new instance of the MailMerge class.

Events

Event Description
TXTextControl.DocumentServer.MailMerge.BarcodeMerged Occurs when a barcode has been merged successfully.
TXTextControl.DocumentServer.MailMerge.BlockMerging Occurs when a merge block is about to be merged.
TXTextControl.DocumentServer.MailMerge.BlockRowMerged Occurs when a merge block row has been merged successfully.
TXTextControl.DocumentServer.MailMerge.ChartMerged Occurs when a chart has been merged successfully.
TXTextControl.DocumentServer.MailMerge.DataRowMerged Occurs when a data row has been merged successfully.
TXTextControl.DocumentServer.MailMerge.FieldMerged Occurs when a field has been merged.
TXTextControl.DocumentServer.MailMerge.ImageFieldMerged Occurs when an image field, i.e., a merge field whose name is prefixed with "image:" has been merged.
TXTextControl.DocumentServer.MailMerge.ImageMerged Occurs when an image has been merged successfully.
TXTextControl.DocumentServer.MailMerge.IncludeTextMerging Occurs when an IncludeText field has been merged.

Interfaces

Interface Description
TXTextControl.DocumentServer.DataSources.IDataRowAdapter The IDataRowAdapter interface contains properties and methods implemented by data row instances used in the BlockMerging event.
TXTextControl.DocumentServer.DataSources.IDataTableAdapter The IDataTableAdapter interface contains properties and methods implemented by data table instances used in the BlockMerging event.

Methods

Method Description
TXTextControl.DocumentServer.MailMerge.GetBlockFieldNames Returns the names of all merge fields inside the merge block with the specified name.
TXTextControl.DocumentServer.MailMerge.GetBlockNames Lists the names of all merge blocks contained in the currently loaded template.
TXTextControl.DocumentServer.MailMerge.LoadTemplate Loads a template from a file that is used for the merge process.
TXTextControl.DocumentServer.MailMerge.LoadTemplateFromMemory Loads a template from memory that is used for the merge process.
TXTextControl.DocumentServer.MailMerge.Merge Merges given data into the loaded document template.
TXTextControl.DocumentServer.MailMerge.MergeBlocks Merges all repeating blocks that are contained in the loaded template with the System.Data.DataTable instances contained in the given System.Data.DataSet.
TXTextControl.DocumentServer.MailMerge.MergeJsonData Merges data given as a JSON string into a document template.
TXTextControl.DocumentServer.MailMerge.MergeObject Merges a single instance of an arbitrary type into the loaded document template.
TXTextControl.DocumentServer.MailMerge.MergeObjects Merges a collection of type System.Collections.IEnumerable containing objects of any type or instances of type System.Collections.Generic.Dictionary with string keys into the loaded document template.
TXTextControl.DocumentServer.MailMerge.Print Prints the merged document.
TXTextControl.DocumentServer.MailMerge.SaveDocument Saves the merged document to a file.
TXTextControl.DocumentServer.MailMerge.SaveDocumentToMemory Saves the merged document.
TXTextControl.DocumentServer.DataSources.IDataRowAdapter.GetChildRows Returns the data of a child relation with a given name as an array of IDataRowAdapter instances.

Properties

Property Description
TXTextControl.DocumentServer.MailMerge.RemoveEmptyBlocks Specifies whether the content of empty merge blocks should be removed from the template or not.
TXTextControl.DocumentServer.MailMerge.RemoveEmptyFields Specifies whether empty fields should be removed from the template or not.
TXTextControl.DocumentServer.MailMerge.RemoveEmptyImages Specifies whether images which don't have merge data should be removed from the template or not.
TXTextControl.DocumentServer.MailMerge.RemoveEmptyLines Specifies whether text lines which are empty after merging should be removed from the template or not.
TXTextControl.DocumentServer.MailMerge.RemoveTrailingWhitespace Specifies whether trailing whitespace should be removed before saving a document.
TXTextControl.DocumentServer.MailMerge.ReportDataSourceConfig Specifies the Report Data Source Configuration as an XML string.
TXTextControl.DocumentServer.MailMerge.ReportDataSourceConfigFile Gets or sets the file path of a Report Data Source Configuration file (*.rdsc) which has been created with TX Text Control Words.
TXTextControl.DocumentServer.MailMerge.SearchPath Specifies a directory name where sub-templates and images (for image merging) should be searched.
TXTextControl.DocumentServer.MailMerge.TemplateFile Specifies the template file path.
TXTextControl.DocumentServer.MailMerge.MergeBlockNamePrefix A static property returning the internal merge block name prefix "txmb_".
TXTextControl.DocumentServer.MailMerge.TextComponent Gets or sets the TextComponent object which is associated with the MailMerge component.
TXTextControl.DocumentServer.MailMerge.UseTemplateFormat Specifies whether the template page size and margins should be used or not.
TXTextControl.DocumentServer.MailMerge.BarcodeMergedEventArgs.BarcodeFrame Gets a BarcodeFrame object representing the merged barcode in the document.
TXTextControl.DocumentServer.MailMerge.BlockMergingEventArgs.ColumnNames Gets the column names of the table supplying the data for the block.
TXTextControl.DocumentServer.MailMerge.BlockMergingEventArgs.BlockName Gets the name of the merge block the event was fired for.
TXTextControl.DocumentServer.MailMerge.BlockMergingEventArgs.BlockData Gets the block data as an array of data rows.
TXTextControl.DocumentServer.MailMerge.BlockRowMergedEventArgs.DataRowNumber Gets an int value that indicates the currently merged data row in the merge block.
TXTextControl.DocumentServer.MailMerge.BlockRowMergedEventArgs.DataRowCount Gets an int value that indicates the total number of data rows.
TXTextControl.DocumentServer.MailMerge.BlockRowMergedEventArgs.MergeBlockName Gets a string value that indicates current merge block name.
TXTextControl.DocumentServer.MailMerge.BlockRowMergedEventArgs.MergedBlockRow Gets or sets a byte[] array that contains the complete data of the merged block row.
TXTextControl.DocumentServer.MailMerge.ChartMergedEventArgs.ChartFrame Gets a ChartFrame object representing the merged chart in the document.
TXTextControl.DocumentServer.MailMerge.DataRowMergedEventArgs.Cancel Gets or sets a value indicating whether the current merge process should be canceled.
TXTextControl.DocumentServer.MailMerge.DataRowMergedEventArgs.DataRow Gets the current data row's content.
TXTextControl.DocumentServer.MailMerge.DataRowMergedEventArgs.DataRowNumber Gets an int value that indicates the currently merged data row.
TXTextControl.DocumentServer.MailMerge.DataRowMergedEventArgs.MergedRow Gets or sets a byte array that contains the complete data of the merged data row.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.DataRow Gets the data row which is used to supply the current field with merge content.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.MailMergeFieldAdapter Gets or sets a MailMergeFieldAdapter that contains the already merged field.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.MergeBlockName If the merge field is part of a merge block, this property returns the name of the block.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.Merged Gets a bool value that indicates whether the current field has been merged successfully or not.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.MergedField Gets or sets a byte array that contains the complete data of the merged field.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.NestingDepth If the merge field is part of a merge block, this property returns the one-based nesting depth of the block.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.TableCell If the merge field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.FieldName Gets the name of the merged field.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.Filename Gets the filename of the merged image.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.Image Gets or sets the image that has been merged into the field.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.MergeBlockName If the image field is part of a merge block, this property returns the name of the block.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.Merged Gets a bool value that indicates whether the current field has been merged successfully or not.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.NestingDepth If the image field is part of a merge block, this property returns the one-based nesting depth of the block.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.TableCell If the image field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.DataRow Gets the data row which is used to supply the current image with merge content.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.ID Gets the ID of the merged image.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.Image Gets or sets the merged image.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.MergeBlockName If the image is part of a merge block, this property returns the name of the block.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.Merged Gets a boolean value that indicates whether the current image has been merged successfully or not.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.Name Gets the name of the merged image.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.NestingDepth If the image is part of a merge block, this property returns the one-based nesting depth of the block.
TXTextControl.DocumentServer.MailMerge.IncludeTextMergingEventArgs.Filename Gets a string that indicates the file name of the IncludeText field to be merged.
TXTextControl.DocumentServer.MailMerge.IncludeTextMergingEventArgs.IncludeTextDocument Sets a byte[] array that contains the complete data of the IncludeText document.
TXTextControl.DocumentServer.MailMerge.IncludeTextMergingEventArgs.IncludeTextField Represents the currently merged INCLUDETEXT field.
TXTextControl.Indexer The indexer of the IDataRowAdapter interface returns the content of the row's column with the given name.
TXTextControl.DocumentServer.DataSources.IDataRowAdapter.Table Gets the table the data row belongs to as an instance of a class implementing the IDataTableAdapter interface.
TXTextControl.DocumentServer.DataSources.IDataTableAdapter.TableName Returns the name of the table.
TXTextControl.DocumentServer.DataSources.IDataTableAdapter.ColumnNames Returns the table's column names as a string array.
TXTextControl.DocumentServer.DataSources.IDataTableAdapter.Rows Returns the table's data as an array of objects implementing the IDataRowAdapter interface.
TXTextControl.DocumentServer.DataSources.IDataTableAdapter.ChildTableNames Returns the names of the child relations in this table as a string array.