Forms

Forms define windows that start with a search (Search tab) and place them on the main form menu. They have additional tabs defined and widgets placed on those tabs. Filters are defined for the Search tab. At least one filter definition is required (e.g. 0. All)

Note that the Forms Form is designed using itself and has Detail and Class tabs which show the form parameters widget and the associated entity widget respectively.  The form parameters widget (hard coded) has 5 tabs.

Tab

Description

Data

Shows the basic properties and the SQL used for the search grid

Columns

Shows a grid of column names and allows setting of column widths and class attributes. These attributes are the same as for a Grid widget.

Search

Specifies the WHERE clauses used when a non-blank entry is keyed in the search omibox. 

Filters

A grid showing the filters that can be applied to the search screen

Tabs

Shows two grids, one showing tab properties and one showing widgets.

 

We will illustrate with the Stock Loans form.

Data Tab

 

Field

Description

Form No

A sequential number allocated by the system

Variant

The default instance =0 {future} define variants

Active

Is this form active

Form ID

A short name starting with frm 

Caption

The forms friendly name. Used for the form’s caption

Hint

The hover hint for the form

Class

The form’s primary Entity class

Abbreviation

An abbreviated name, used in the active windows list.

SiteMap

Where to place on the main form menu.

  Menu levels are delimited by the vertical bar character (|)

Glif

The Glif number used on the menu

Select SQL

The SQL used for the Search tab grid

 

Columns Tab

This shows additional column related info for the Search SQL and allows setting of column attributes and default column widths.  The available attributes are the same as for Grid widgets.

 

Column

Description

No

The columns sequential number

Caption

This is set in the SQL using column name or alias

Data Type

Determined from the database metadata 

Data Size

Determined from the database metadata 

ColWidth

The default width in pixels for the column

Attribute

Attributes can be Entities, Functions, or Formats

  e.g.  eptStock, faNartv (narrative link),  fmtQty (format)

Attribute Description

Shows a friendly description for the attribute

 

Notes:

·         Column widths can be set to zero to hide them by default

·         Entity attribute values are passed to the widgets when a search row is selected.  A search column is therefore required for each of the primary entities of the form’s widgets.

·         Function attributes can be used to update various fields on the form’s grey bar or even change its background colour.

·         Format attributes can be used to format a column e.g. fmtQty will right align the column and set the decimal places according to the Exocfg Essential setting.

Search Tab

These are only used if there is a search string in the onmi-box. If the search string is pure numeric then the Numeric SQL is added to the WHERE clause of the search else the Alphanumeric SQL is used.  Note that the token :Search is replaced with the search string.  This will be prefixed/suffixed with the wildcard character depending on the setting of the Search Align button.

Filters Tab

Filters appear in a combo-box to the right of the omni-box.  At least one filter is required. It is recommended that 0.All be used. The default filter for Select and Close search mode can be specified on the Entity.

Column

Description

Filter No

Controls the sequence filters will appear in the combo-box

Name

The name of the filter that will appear in the combo-box

Hint

A more verbose description of the filter 

Filter SQL

An SQL WHERE clause that will be added to the search query

SeqNo

An internally allocated number

 

Tabs Tab

 

This tab has two grids.  The upper (Tabs) grid lists what tabs that will appear after a record is selected from the search tab.  The lower (Widgets) grid lists the widgets that will be shown on these tabs.

Tabs Grid

Column

Description

Tab

Tab number, Tab 0 is always Search

Caption

The tab’s caption

Hint

The hover hint for the tab 

Ribbon

Which ribbon panes will be shown (if showing ribbon, not toolbar)

Help

Help context to link to this help file

DockSite

Does this tab allow widgets to be docked

Enabled

Is the tab enabled by default (essentially = Is Active)

Visible

Is the tab visible by default

SelClose

Show this tab when in Select and Close mode

Glif

The Glif number used on the tab

SeqNo

An internally allocated number

 

Notes:

·         DockSite: Some special forms can use tab 1 for hard-coded presentation that is not a widget.

·         Enabled: Effectively this is an Active flag.

·         Visible: If tab is not visible but is enabled then its widgets still run in the background

 Widgets Grid

Column

Description

Tab No

Specifies which tab the widget is to appear on

Tab Name

The name of the tab (derived from top grid)

Sequence

The sequence in which widgets are added to a tab.

Caption

Defines the caption of the widget

Widget Number

Which widget to place

Class

The Entity class required for the widget

Widget Description

Displays the widget’s Widget Name

Class Description

Displays the entity’s Description

SeqNo

An internally allocated number

 

Notes:

·         Sequence: Each additional widget is placed below the previously added widget.

·         Caption: The caption of the widget is specified here. The caption is not taken from the widget name. Widgets are sometimes multi-class.

·         Class: An Entity class is required for the widget so that it knows which record to show after being passed this class from the search tab when a record is selected. E.g the Stock Loan passed the Company Form an Account number being a Debtor. The account form then knows it is is Debtor mode and which debtor to show.


 

DUO for EXO     DUO for EXO     © Dyameta Technology Ltd                     Previous Topic           Next Topic           Home