You are here: Function Reference > Field Functions

Field Functions

Field functions retrieve or change data associated with variable fields defined on sections. The variable field functions are summarized in the table below. Click on the function name to jump to a discussion of that function.

Note

Before you examine each field function individually, you should understand the available field formats and how to locate a specific field.

Function	Result
@	Returns the value contained in a field.
AppendText	Append text into a multiline text field from an external text file.
AppendTxm	Append text into a multiline text field from an external multiline text area.
AppendTxmUnique	Append text into a multiline text field from an external multiline text area and rename the fields imported from the external text area so they have unique names.
CompressFlds	Compresses blank space by moving field data.
ConnectFlds	Repositions and aligns field text along a common horizontal coordinate so the field’s data appears concatenated.
DelField	Deletes a field from a section.
FieldFormat	Returns the format string associated with the field format type.
FieldPrompt	Returns the text of the prompt for a field.
FieldType	Returns the field format type assigned to a field.
FieldX	Returns the X coordinate of a field object.
FieldY	Returns the Y coordinate of a field object.
JustField	Justifies a variable field content by modifying its field coordinates.
MAX	Returns the maximum value found in a set of fields that share a naming method.
MIN	Returns the minimum value found in a set of fields that share a naming method.
NUM	Return the numeric value from a field regardless of the field’s format.
ResetFld	Clears a field of data.
SetFld	Assigns a value to a section field.
SetFont	Change the font on a field.
SetLink	Updates a hyperlink setting in a variable field, a graphic, or a text label.
SetProtect	Prevents a specified field from being altered.
SetRequiredFld	Changes the required option of a field to Required or Not Required.
Size	Returns the integer size of the data area of a section field.
SpanField	Moves a field horizontally and then resizes it to span the distance between two other specified fields.
STR	Return the contents of a field as a string without conversion.

Field Functions

See Also