Sets the value of a field in a document. The existing contents of the field, if any, are written over.

Defined in

NotesUIDocument

Syntax

Call notesUIDocument.FieldSetText( fieldName$, textValue$ )

Parameters

fieldName$

String. The name of the field with the value you want to set. The field must be editable. Specify an empty string ("") to set the value of the current field.

String. The value you want to give to the field. If the fieldName$ is not of type text, this value is converted from text to the appropriate data type when you save the document.

This method is valid only when the document is in Edit mode. To enter multiple values for a multi-value field, separate the values with the input separator as specified in the field properties.

Errors

If a script attempts to call FieldSetText when a document is not in Edit mode, it raises the error: "You must be in Edit mode to change the value of a field."

Language cross-reference

@SetDocField function in formula language

@SetField function in formula language

Example
See Also

CurrentField property
EditMode property
FieldAppendText method
FieldClear method
FieldContains method
FieldGetText method

Glossary