Form

Reference documentation for individual Form items in the Solution Explorer

Overview

In a Servoy application, forms serve as the primary units of UI space. Each form designates a screen area for interacting with UI components, data, and scripted logic. Double-clicking on this item will open the Form Editor.

Expanding a form will show the items contained in the form, UI, as well as data and logic related:

• controller

• variables

• elements When the case, extra items are visible:

• containers: by right-clicking on this item, the user has the option to Toggle Form Commands and to Add to working set.

• selectedrecord: this item's contextual list contains all avaialable dataproviders given by the form's datasource (for example table columns, aggregations, calculations, etc.)

• relations

Properties Summary

See Form for properties that can be set on a Form from Properties View.

Commands Summary

A summary of commands available on this item via right-click context menu:

Command	Summary
Open in Form Editor	Opens the Form Editor
Open Form Hierarchy	Opens the Form Hierarchy
Open in Debug Client	Opens Form in Titanium Client
Open in Script Editor	Opens the form Script Editor
Create method	Create a new form method
Create new sub form	Opens the New Form Wizard to create subform
Toggle Form Commands	Opens the Form Editor
Add to working set	Adds form to a Working Set
Duplicate form	Creates a (deep) copy of the form
Delete form	Deletes form from workspace
Rename form	Change form name
Run JSUnit tests	Runs JSUnit tests from the form
Search for References	Search all references in your active solution

Properties Summary

A summary of properties for this item, which can be configured in the Properties Editor. See Form Object Model for properties that can be modified in Properties Editor.

Commands Details

The details for each command available on this item via right-click context menu:

Open in Form Editor

Opens the Form Editor. A form has two parts, user interface file and scripting file. In Form Editor you can change the design of the form.

Open Form Hierarchy

Opens the Form Hierarchy. There you see the hierarchy tree (according to parent-child relation).

Open in Debug Client

Open form in Titanium Client. The client opened from Servoy Developer is a Debug Client (as you can debug through it). If you have an opened Client, you can open the selected form in it (as main form).

Open in Script Editor

Opens the form Script Editor. Each form has a design file and a scripting file (javascript code). Is used to encapsulate code specific to that form, that should not be reused from another form (except through inheritance).

Create method

Create a new form method (javascript function in form scripting file).

Create new sub form

Opens the New Form Wizard to create child form (new form whose parent is the selected form).

Toggle Form Commands

Opens the Form Editor. A form has two parts, user interface file and scripting file. In Form Editor you can change the design of the form.

Add to working set

Add the form to a working set (like a logical folder for that form).

Duplicate form

Creates a (deep) copy of the form. You can choose the new form name.

Delete form

Deletes the form from workspace.

Rename form

Can choose a new name for the form.

Warning This may break your solution if you use the hard coded name in some code of your solution.

Run JSUnit tests

Runs JSUnit tests from selected form. See Unit Testing for what is unit testing and JSUnit API for JSUnit testing API.

Search for References

Search all references of the form in your active solution.

Contextual List

Here are the item details that appear in the contextual list and each command available via right-click:

• form name:

  • Move Code

  • Move Sample

  • Create method

• foundset:

  • Move Code

  • Move Sample

  • Create method

When the case, extra items are visible:

• methods and events:

  • Move Code

  • Open in Script Editor

  • Debug Method

  • Search for References

  • Create method

  • Overrride method - applies in case there are inherited methods on the form

  • Delete method

  • Run JSUnit test(s)

  • Open Form Hierarchy