TX Text Control .NET for Windows Forms

MergeBlockSettings Class

Class|Introduced in 24.0
Namespace
TXTextControl.DocumentServer.DataSources
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXDocumentServer.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXDocumentServer.dll from the setup.

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 MergeBlockSettings

Examples

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;

Members

Constructors

ConstructorDescription
MergeBlockSettingsInitializes a new instance of the MergeBlockSettings class.

Properties

PropertyDescription
AddResultReturns whether the new block has successfully been inserted by DataSourceManager.InsertMergeBlock. The default value is SubTextPartCollection.AddResult.Error.
BlockTemplateTypeGets or sets a value of type BlockTemplateType which specifies the type of the inserted repeating block. (paragraph based or table row based)
CreatedTableReturns the table created by DataSourceManager.InsertMergeBlock if property BlockTemplateType was set to BlockTemplateType.TableRow. The default value is null.
CreateHeaderRowIf this property is true and property BlockTemplateType is set to BlockTemplateType.TableRow, a table header row is automatically generated.
FieldDisplayModeGets 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.
HighlightColorSpecifies 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.
TableIDGets 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.