MergeBlockSettings Class
- Namespace
TXTextControl.DocumentServer. DataSources
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. Core. SDK
- Assembly
TXDocumentServer.Core. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. Core. SDK TXDocumentServer.from the setup.dll
- Also in
TXTextControl.asTextControl. ASP. SDK TXDocumentServer.dll
Description
The MergeBlockSettings class is used to insert a table or paragraph based repeating merge block into a TextControl instance using the DataSourceManager.InsertMergeBlock method.
Syntax
public class MergeBlockSettingsPublic Class MergeBlockSettingsExamples
The following example creates a Merge Block Settings instance and configures its block template type setting for a document workflow.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings mergeBlockSettings = new();
mergeBlockSettings.BlockTemplateType = TXTextControl.DocumentServer.DataSources.BlockTemplateType.TableRow;Dim mergeBlockSettings As New TXTextControl.DocumentServer.DataSources.MergeBlockSettings()
mergeBlockSettings.BlockTemplateType = TXTextControl.DocumentServer.DataSources.BlockTemplateType.TableRowMembers
Constructors
| Constructor | Description |
|---|---|
| MergeBlockSettings | Initializes a new instance of the MergeBlockSettings class. |
Properties
| Property | Description |
|---|---|
| AddResult | Returns whether the new block has successfully been inserted by DataSourceManager.InsertMergeBlock. The default value is SubTextPartCollection.AddResult.Error. |
| BlockTemplateType | Gets or sets a value of type BlockTemplateType which specifies the type of the inserted repeating block. (paragraph based or table row based) |
| CreatedTable | Returns the table created by DataSourceManager.InsertMergeBlock if property BlockTemplateType was set to BlockTemplateType.TableRow. The default value is null. |
| CreateHeaderRow | If this property is true and property BlockTemplateType is set to BlockTemplateType.TableRow, a table header row is automatically generated. |
| FieldDisplayMode | Gets or sets a value of type FieldDisplayMode which specifies the content display mode of the inserted fields. Either the field text or the field codes can be displayed. |
| HighlightColor | Specifies the color the inserted merge block is highlighted with if the input position is inside the block. The alpha value of the provided color is used. |
| TableID | Gets or sets the ID of the table created by DataSourceManager.InsertMergeBlock. Must be 0 (no ID) or a value between 10 and short.MaxValue. The default value is 0. |