TXTextControl.ApplicationField Class

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.

Introduced: 14.0.

Syntax

[C#]
public class ApplicationField : TextField
[Visual Basic]
Public Class ApplicationField
  Inherits TextField

Constructors

Constructor Description
ApplicationField Initializes a new instance of the ApplicationField class.

Properties

Property Description
Bounds Gets the bounding rectangle of a text field. (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. (Inherited from TextField.)
DoubleClickEvent Specifies whether a TextControl.TextFieldDoubleClicked event is raised, if the end-user doubleclicks the text field. (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. (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. (Inherited from TextField.)
Format Gets or sets the field's format.
FormattingBounds Gets the formatting rectangle of a text field. (Inherited from TextField.)
ID Gets or sets an identifier for a text field. (Inherited from TextField.)
IsSpellCheckingEnabled Specifies whether a text field's text is checked on misspelled words. (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. (Inherited from TextField.)
Parameters Gets or sets the field's parameters.
ShowActivated Specifies whether a text field toggles its background to gray, if the current input position is in the field. (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. (Inherited from TextField.)
TypeName Gets or sets the field's type name.

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

Example

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

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

textControl1.ApplicationFields.Add(myAppField);
[Visual Basic]
Dim MyAppField As TXTextControl.ApplicationField = New TXTextControl.ApplicationField( _
  TXTextControl.ApplicationFieldFormat.MSWord, _
  "MERGEFIELD", _
  "New ApplicationField", _
  New String() {"FieldName"})

TextControl1.ApplicationFields.Add(MyAppField)

See Also