TX Text Control ActiveX Documentation

TXTextControl.FieldTypeData Property

Description:This property sets or returns the data that belongs to a marked text field of a special type. The chapter Technical Articles - Marked Text Fields - Special Types of Marked Text Fields informs about all the types and the data belonging to these types.

Syntax:
TXTextControl.FieldTypeData(FieldId) [= TypeData]
ParameterDescription
FieldIdIdentifies the field that is to be manipulated. The specified data can be a long value or a character string depending on the type of the field. For the different field types the corresponding data are listed in the following Constants section.

Constants:The following lists the possible data for each type of field. The corresponding data type is listed in Data Types:

ConstantDescription
txFieldExternalLink (1)Defines the external location to where the link points.

txFieldInternalLink (2)Defines the location in the same document to where the link points.

txFieldPageNumber (3)Defines the starting number and the number format. To display the number in a certain format the following constants can be added to the starting number:

ConstantDescription
&H30000Pages are numbered with Arabic numbers (1, 2, 3, ...).

&H40000Pages are numbered with small letters (a, b, c, ...).

&H50000Pages are numbered with capital letters (A, B, C, ...).

&H60000Pages are numbered with Roman numbers (I, II, III, ...).

&H70000Pages are numbered with small Roman numbers (i, ii, iii, ...).


txFieldLinkTarget (4)Defines the name of a target.

txFieldHighlight (5)Defines the color of the highlight.

txFieldTopic (6)Defines the number of the topic.

txFieldMSWord (7)Defines the type name and parameters of a Microsoft Word field as a sequence of strings, separated through TAB (9) characters. The first string specifies the type name of the field (for example: MERGEFIELD). The following strings are the field's parameters which can be arguments and switches. Each switch begins with a backslash.

txFieldHighEdit (8)Defines the name and parameters of the Heiler Highedit field as a sequence of strings, separated through TAB (9) characters.

Data Types:
FieldId:Integer
txFieldExternalLinkString
txFieldInternalLinkString
txFieldPageNumberLong
txFieldLinkTargetString
txFieldHighlightLong
txFieldTopicLong
txFieldMSWordString
txFieldHighEditString

Limitations:Run time only.

Example:The following example numbers pages with Roman numbers starting with number 3:
TXTextControl1.FieldTypeData(1) = 3 + &H60000
See also:Hypertext Links, Marked Text Fields, FieldInsert Method, FieldLinkClicked Event.