GetFormResult(), GetFormResult$()

Syntax

GetFormResult(BookmarkName$)

GetFormResult$(BookmarkName$)

Remarks

GetFormResult() returns a number corresponding to the setting of a check box form field or drop-down form field marked by the bookmark BookmarkName$. (Word adds a bookmark automatically when you insert a form field.) GetFormResult() returns values as follows:

• For a check box form field, returns 0 (zero) if the check box is cleared or 1 if it is selected.
• For a drop-down form field, returns 0 (zero) if the first item is selected, 1 if the second item is selected, and so on.

Note that an error occurs if you use GetFormResult() with a text form field.

GetFormResult$() returns a string corresponding to the setting of the form field marked by the bookmark BookmarkName$. GetFormResult$() returns values as follows:

• For a check box form field, returns "0" (zero) if the check box is cleared or "1" if it is selected.
• For a drop-down form field, returns the item that is currently selected.
• For a text form field, returns the current text.

Example

This is an example of an "on-exit" macro that tests the item selected in a drop-down form field as soon as the user moves the focus to another form field. If the item is "Paris," a message box is displayed. The on-exit macro is assigned to the field marked by the bookmark "Dropdown1."

Sub MAIN
city$ = GetFormResult$("Dropdown1")
If city$ = "Paris" Then
MsgBox "We offer daily excursions to Versailles!"
End If
End Sub

For more information about on-exit macros, see Chapter 9, "More WordBasic Techniques," in Part 1, "Learning WordBasic."

See Also

SetFormResult