The PublicFunctions.js script file defines functions and globals that can be used from Form scripts and macros.

PublicFunctions.js defines the following global functions:

• GetApp() provides access to the Forms Tool UIDelegate, which provides access to the Groove runtime environment and to Groove services. For example, you can use it to find the members of the workspace, send instant messages, and open transactions to lock the workspace while you are accessing a record. In macros, this function is not available but the Forms Tool UIDelegate is provided as a parameter.
• CreateBSTREnumFromArray: allows you to convert an array of strings into an Enum object, which is used as a parameter in some of the Forms Tool UIDelegate operations.

CreateBSTREnumFromArray(i_StringArray) As IGrooveBSTREnum

• SetFieldLabel: Sets the label of the specified field.

SetFieldLabel(i_FieldName, i_Label)

• HideField: Hides a field or displays a previously hidden field. If the i_bHide parameter is true , this operation hides the field. If i_bHide is false , it displays the field HideField(i_FieldName, i_bHide)
• DisableField: Disables or enables a field. If the i_bDisable parameter is true, this operation disables the field. If i_bDisable is false, it enables the field. Note that if this operation attempts to disable a field that cannot be disabled, the operation has no effect.

DisableField(i_FieldName, i_bDisable)

PublicFunctions.js defines the following global variables:

• g_IsNew: a boolean, which is true if the form is creating a new record and false otherwise. In macros, this global has no meaning.
• g_IsSearch: a boolean, which is true if the form was opened in a search dialog and false otherwise. In macros, this global has no meaning.
• g_IsFormPreview: a boolean, which is true if the form is opened in the preview layout of the Forms designer and false otherwise. Note that if the form is opened in the user data preview pane, this variable is false and g_IsPreviewPane is true . In macros, this global has no meaning.
• g_IsPreviewPane: a boolean, which is true if the form is opened in the preview pane and false otherwise. In macros, this global has no meaning.
• g_IsReadOnly: a boolean, which is true if the underlying record is read-only, that is the current user cannot update the record, and false otherwise.
• g_IsResponse: a boolean, which is true if the underlying record is a response to another record and false otherwise.
• g_IsVersioned: a boolean, which is true if the underlying record is a versioned record and false otherwise. A versioned record is created when a record is modified. The previous values are saved as a versioned record, which is a child of the active record.
• g_FormRecord: provides access to the underlying forms record. See the following section for information on accessing data in the record. In macros this global is not meaningful, but the record is provided by a parameter.