TX Text Control .NET Server

ApplicationField Constructor

Constructor|Introduced in 14.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK as TXTextControl.Core.dll from the private NuGet feed or Text Control Offline Packages
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Initializes a new instance of the ApplicationField class. The format of the parameters depends on the application that supports the field. The field is initialized without syntax check.

Syntax

public ApplicationField(ApplicationFieldFormat format, string typeName, string text, string[] parameters);

Parameters

ParameterDescription
format

Specifies the format of the field. The format depends on the application that supports the field. It can be ApplicationFieldFormat.MSWord or ApplicationFieldFormat.HighEdit.

typeName

Specifies the type name of the field. For example the type name of a Microsoft Word MergeField is MERGEFIELD.

text

Specifies the visible text of the field.

parameters

Specifies an array of strings which are the field's parameters. The order and format of the strings depend on the field's format. For example a Microsoft Word MergeField has the following format: MERGEFIELD FieldName [switches]. In this case the first string of the array is the FieldName and the following strings are possible switches. If a field has no parameters, null can be specified.

Examples

The following example inserts and configures a Word-compatible mail-merge field.

textControl.Text = "Dear Customer";
textControl.InputPosition = new InputPosition(5);
ApplicationField applicationField = new(ApplicationFieldFormat.MSWord, "MERGEFIELD", "Customer", new[] { "CustomerName" });
textControl.ApplicationFields.Add(applicationField);