AppendTxm

Use this procedure/function to append text to the end of a multiline text field from a text area on another section (FAP) file. This procedure only works on multiline text fields.

Syntax

AppendTxm (FAP, InsertFld, Field, Section, Form, Group)

Parameter

Description

FAP

Enter the name of the section file which contains the text area you want to append to the field you specify in the Field parameter.

If you omit the path, the system looks for this section in the forms directory you specified using the File, Library Setup option.

InsertFld

This parameter determines where in the tabbing sequence any embedded variable fields will be placed.

Use this parameter to specify the name of the variable field (on the current section) before which you want the embedded fields in the imported text area inserted.

For example, if your form contains three variable fields (Y1, Y2, Y3). The text area to be inserted contains two variable fields (Z1, Z2). By specifying Y2 as the InsertFld, you tell the system to tab to fields Z1 and Z2 before tabbing to Y2 when in entry mode.

The default is to append after the last field on the section.

Field

Enter the name of the field that identifies the multiline text area which will receive the appended text. The default is the current field, which must be a multiline text field.

Section

Enter the name of the section that contains the field you specified in the Field parameter. The default is the current section.

Form

Enter the name of the form that contains the section you specified in the Section parameter. The default is the current form.

Group

Enter the name of the group that contains the form you specified in the Form parameter. The default is the current group.

The system optionally returns a one (1) if successful and zero (0) if unsuccessful.

When used with Documaker Desktop, use the Refresh procedure to make sure all appended text appears in the field.

Example

Here are some examples:

Procedure

Result

Explanation

#rc = AppendTxm

("Message", , "Name_Line"); Refresh ( );

1 or 0

The text in the first text area on the section named Message is appended to the multiline text field, called Name_Line. The system then refreshes the display.

#rc = AppendTxm (".\mstrres\messages\msg1", , "Name_Line", "Mailer"); Refresh ( );

1 or 0

The path, .\mstrres\message\, is appended to the multiline text field, called Name_Line, which is on the section named Mailer. The system then refreshes the display.

#rc = AppendTxm("message", "Address1" , "Name_Line"); Refresh ( );

1 or 0

The fields in the text area are inserted before the variable field named Address1, in the tabbing sequence. The system then refreshes the display.

See also