Forms

[WINDEV]

Last Edit: January 30, 2018 the alpha360 team

Forms Structure

All Form windows have the following definition:

IWF_MyForm(LOCAL p_OpenWindow is ST_a360_DynamicWindow,sReturnPK is string="", bChanged is boolean=False)

Independent HFSQL context:

always turned ON

UI elements:

They usually have edit controls, combos etc. linked to local window variables

The Embeds [most common]:

End of Initialization of IWB_MyForm

UI_UserAccess()                  // Controls user access

UI_Format()                      // Formats currencies and numbers

UI_Translate                     // Translate the Window

UI_Init()                        // Clears or Retrieves data etc .

The LOCAL Procedures [most common]:

UI_UserAccess()                  // Controls user access

UI_Format()                      // Formats currencies and numbers

UI_RefreshWindow()               // Refreshes windows UI

UI_RefreshLookups()              // Refreshes COMBO boxes etc .

UI_Init                          // Clears or Retrieves data etc .

UI_Cancel                        // Cancels the editing ...

UI_Close                         // Closes the form

UI_Save                          // Saves - completes and Add, Edit or Delete

UI_CheckRequiredFields           // Checks for missing data

UI_CleanUpData                   // Clean up data

UI_CreateTranslation             // Automatically Create Translation entries

Simple Forms WorkFlow

Forms are usually used when adding (or editing or deleting or viewing) simple objects - like product records - or more complex objects - like invoices.

They are usually called from Browses but you can call them from anywhere you want.

Lets see how the IWF_Product form works:

1. Pass a p_OpenWindow structure to the IWF_Product form when we "call it"

2. In the Global declarations area of the form we create 2 variables of type gProduct

r_gProduct is Record of gProduct
rc_gProduct is Record of gProduct
we can compare the above 2 variables - when a user saves the form - to see if anything has really changed !!!

3. call UI_UserAccess

4. call UI_Format

5. call UI_Translate

6. call UI_Init

IF p_OpenWindow.nAction = 1 was passed -> this is an ADD/INSERT

so initialize any variables and let the user fill the edit controls ...

IF p_OpenWindow.nAction = 2 (or 3 or 4) this is an EDIT (or DELETE or VIEW)

retrieve the Product record by using the primary key passed by p_OpenWindow.sPK and handle any errors
copy the file buffers to the r_gProduct and the rc_gProduct variables
let the user do the editing ...
IMPORTANT note -> ALL edit controls are LINKED to data from the r_gProduct variable and NEVER from data from the file buffers

7. the user clicks the Save Button and UI_Save is executed

call UI_CheckRequiredFields
call UI_CleanUpData
call a BP - depending on the p_OpenWindow.nAction ; if the BP is succesful it returns TRUE and the form is closed - otherwise the user is informed of the error and he can continue his editing or do a cancel.
IMPORTANT note -> We always pass VARIABLES to BPs and never FILE Buffers.

Complex Forms WorkFlow

Complex forms generally work the same way as simple forms do.

They just have to handle data in temporary tables also - like products in invoices.

Take a look at the code in the IWF_Sales procedure and post any questions you may have in our support forums.

next - > Reports [WIN}

Report abuse