Description

The ApplicationField class supports text field formats of applications such as Microsoft Word. The class only provides an interface to retrieve and change the data and parameters of such fields. The field logic itself is not implemented. Currently supported applications and components are Microsoft Word and Heiler HeighEdit. For more information see the technical article Text Fields and Hypertext Links - Importing Fields from Microsoft Word.

Syntax

public class ApplicationField : TextField

Public Class ApplicationField
    Inherits TextField

Examples

The following example shows how to insert a new ApplicationField of type Microsoft Word.

TXTextControl.ApplicationField myAppField = new TXTextControl.ApplicationField(
  TXTextControl.ApplicationFieldFormat.MSWord,
  "MERGEFIELD",
  "New ApplicationField",
  new string[] {"FieldName"});

textControl1.ApplicationFields.Add(myAppField);

Dim MyAppField As TXTextControl.ApplicationField = New TXTextControl.ApplicationField( _
  TXTextControl.ApplicationFieldFormat.MSWord, _
  "MERGEFIELD", _
  "New ApplicationField", _
  New String() {"FieldName"})

TextControl1.ApplicationFields.Add(MyAppField)

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);

textControl.Text = "Dear Customer"
textControl.InputPosition = New InputPosition(5)
Dim applicationField As New ApplicationField(ApplicationFieldFormat.MSWord, "MERGEFIELD", "Customer", New String() { "CustomerName" })
textControl.ApplicationFields.Add(applicationField)

Members

Constructors

Constructor	Description
ApplicationField	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.
TextField	Creates a new instance of the TextField class. (Inherited from TextField.)

Properties

Property	Description
Bounds	Gets the bounding rectangle of a text field. The bounding rectangle is the smallest rectangle which contains all characters of the field's text. The rectangle is given in twips with an origin at the upper left corner of the document. (Inherited from TextField.)
ContainsInputPosition	Returns true, if the Textfield contains the current text input position. (Inherited from TextField.)
Deleteable	Specifies whether a text field can be deleted by the end-user while a TX Text Control document is being edited. The default setting of this property is true. (Inherited from TextField.)
DoubleClickEvent	Specifies whether a TextControl.TextFieldDoubleClicked event is raised, if the end-user doubleclicks the text field. If an event is raised, the normal double-click processing, which selects a single word in the text is suppressed. The default setting of this property is true. (Inherited from TextField.)
DoubledInputPosition	Specifies whether a text field has a doubled input position in front of its first character and behind its last character. This enables an end-user to decide whether inserted text at these positions will belong to the text field or not. The default setting of this property is false. For all form fields to work properly this property is set to true and cannot be changed to false. (Inherited from TextField.)
Editable	Specifies whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. The default setting of this property is true. (Inherited from TextField.)
Format	Gets or sets the field's format. The property's value can be one of the ApplicationFieldFormat values. If the format of the field is changed, its type name and parameters must also be changed.
FormattingBounds	Gets the formatting rectangle of a text field. The formatting rectangle is the largest rectangle to which the area covered by the field can grow. The rectangle is given in twips with an origin at the upper left corner of the document. (Inherited from TextField.)
HighlightColor	Gets or sets the highlight color for the text field. The color's alpha value must be less than 255 (opaque) so that the text field's text remains visible. The default value is black with an alpha value of 60 (light gray). (Inherited from TextField.)
HighlightMode	Gets or sets a value indicating when the text field is highlighted. (Inherited from TextField.)
ID	Gets or sets an identifier for a text field. This identifier can be used to uniquely identify a text field. (Inherited from TextField.)
IsSpellCheckingEnabled	Specifies whether a text field's text is checked on misspelled words. The default setting of this property is true. (Inherited from TextField.)
Length	Gets the number of characters in a text field. (Inherited from TextField.)
Name	Relates a user-defined name to a text field. This can be any kind of text. This name can be used to uniquely identify a text field. (Inherited from TextField.)
Parameters	Gets or sets 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. The string MERGEFIELD is the type name of the field and can be obtained through the ApplicationField.TypeName property. If a field has no parameters, this array is null.
ShowActivated	Obsolete. Specifies whether a text field toggles its background to gray, if the current input position is in the field. The default setting of this property is false. This property is obsolete and has been superseded by the HighlightColor and HighlightMode properties. (Inherited from TextField.)
Start	Gets the first character position (one-based) of a text field. (Inherited from TextField.)
Text	Returns or sets the text which is contained within a text field. This property is not supported for the DocumentTarget class. (Inherited from TextField.)
TypeName	Gets or sets the field's type name. For example for the type name of a Microsoft Word MergeField is MERGEFIELD. If the type name of the field is changed, its parameters must also be changed.

Methods

Method	Description
ScrollTo	Sets the current input position to the beginning of a text field and scrolls it into the visible part of the document. (Inherited from TextField.)

ApplicationField Class