Merge Method
- Namespace
TXTextControl.DocumentServer. DataSources
- Package
TXTextControl.asTextControl. WinForms. SDK TXDocumentServer.from the private NuGet feed or Text Control Offline Packagesdll
Description
Merges a binary TX internal unicode format document with the currently loaded data source.
Syntax
Merge(byte[], int, object, MergeSettings)
Merges a maximum number of data rows.
public IList<byte[]> Merge(byte[] template, int maxDocuments, object textControl, MergeSettings mergeSettings);Public Function Merge(template As Byte(), maxDocuments As Integer, textControl As Object, mergeSettings As MergeSettings) As IList(Of Byte())| Parameter | Description |
|---|---|
| template | A binary TX internal unicode format document into which the data is merged. |
| maxDocuments | Specifies the maximum number of merged documents. |
| textControl | A TextControl instance needed for licensing purposes. Must be of one of the following types: ServerTextControl, TextControl or WPF.TextControl. |
| mergeSettings | A MergeSettings instance for providing additional merge settings. |
Merge(byte[], int, object)
Merges a maximum number of data rows.
public IList<byte[]> Merge(byte[] template, int maxDocuments, object textControl);Public Function Merge(template As Byte(), maxDocuments As Integer, textControl As Object) As IList(Of Byte())| Parameter | Description |
|---|---|
| template | A binary TX internal unicode format document into which the data is merged. |
| maxDocuments | Specifies the maximum number of merged documents. |
| textControl | A TextControl instance needed for licensing purposes. Must be of one of the following types: ServerTextControl, TextControl or WPF.TextControl. |
Merge(byte[], object, MergeSettings)
Merges all data rows.
public IList<byte[]> Merge(byte[] template, object textControl, MergeSettings mergeSettings);Public Function Merge(template As Byte(), textControl As Object, mergeSettings As MergeSettings) As IList(Of Byte())| Parameter | Description |
|---|---|
| template | A binary TX internal unicode format document into which the data is merged. |
| textControl | A TextControl instance needed for licensing purposes. Must be of one of the following types: ServerTextControl, TextControl or WPF.TextControl. |
| mergeSettings | A MergeSettings instance for providing additional merge settings. |
Merge(byte[], object)
Merges all data rows.
public IList<byte[]> Merge(byte[] template, object textControl);Public Function Merge(template As Byte(), textControl As Object) As IList(Of Byte())| Parameter | Description |
|---|---|
| template | A binary TX internal unicode format document into which the data is merged. |
| textControl | A TextControl instance needed for licensing purposes. Must be of one of the following types: ServerTextControl, TextControl or WPF.TextControl. |
Return Value
An IList of byte arrays containing one binary TX internal unicode format document for each merged data row.
Examples
The following example uses Merge in a focused Data Source Manager workflow.
var result = dataSourceManager.Merge(new byte[] { 1 }, "Approved");
Console.WriteLine($"Merge result: {result}");Dim result = dataSourceManager.Merge(New Byte() { 1 }, "Approved")
Console.WriteLine($"Merge result: {result}")