Assigns a value to a field stored within a document (use @Set for temporary variables). This is similar to using the FIELD keyword, except that @SetField can be used within another @function. If the field does not exist, this command creates it and applies the specified value to it.

Syntax

@SetField( fieldName ; value )

Parameters

fieldName

The name of the field whose value you want to set, enclosed in quotation marks.

The value you want to give to fieldName. The value must be the same data type as the field; for example, if the field is numeric, the value must be a number.

This function is most useful in agents, hotspot buttons, actions, and toolbar buttons. It does not work in column, selection, hide-when, window title, or form formulas.

With Release 6, you no longer need to declare the field receiving the assignment prior to setting its value with @SetField. For R5 or earlier clients, declare the field at the beginning of the formula, as follows:

FIELD Fieldname:=Fieldname;

The field that @SetField creates and assigns the specified value to if the specified field does not exist in the document is not visible to the user. You can remove a field added to a form this way using the @DeleteField function.

Language cross-reference

FieldSetText method of LotusScript NotesUIDocument class

ReplaceItemValue method of LotusScript NotesDocument class

replaceItemValue method of Java Document class

Example
See Also

@Set
Accessing the current document in LotusScript classes
Accessing the current document in the formula language
@SetEnvironment
SaveOptions code example from the Sandbox on the Lotus Developer Domain
"Adding a priority icon to the Inbox" on Tips from the Lotus Developer Domain
"The LotusSphere 2001 contest database" on the Lotus Developer Domain

Glossary