Subform

Um subformulário é um formulário incluído noutro formulário.

Terminologia

In order to clearly define the concepts implemented with subforms, here are some definitions for certain terms used:

• Subform: a form intended for inclusion in another form, itself called the parent form.
• Parent form: a form containing one or more subform(s).
• Subform container: an object included in the parent form, displaying an instance of the subform.
• Subform instance: the representation of a subform in a parent form. This concept is important because it is possible to display several instances of the same subform in a parent form.
• Formulário lista: instância do subformulário exibido como uma lista.
• Detail form: page-type input form associated with a list-type subform that can be accessed by double-clicking in the list.

Sub formulários lista

Um subformulário lista permite que você insira, visualize e modifique dados em outras tabelas. You usually use list subforms in databases in which you have established One to Many relations. A list subform on a form in a related One table lets you view, enter, and modify data in a related Many table. Você pode ter vários subformulários provenientes de tabelas diferentes no mesmo formulário. However, it is not possible to place two subforms that belong to the same table on the same page of a form.

For example, a Contacts manager database might use a list subform to display all the telephone numbers for a particular contact. Although the telephone numbers appear on the Contacts screen, the information is actually stored in a related table. Using a One to Many relation, this database design makes it easy to store an unlimited number of telephone numbers per contact. With automatic relations, you can support data entry directly into the related Many table without programming.

Although list subforms are generally associated with Many tables, a subform instance can display the records of any other database table.

Também é possível permitir que o usuário introduza dados no formulário Lista. Depending on the configuration of the subform, the user may display the detail form by double-clicking on a subrecord or by using the commands for adding and editing subrecords.

4D offers three standard actions to meet the basic needs for managing subrecords: Edit Subrecord, Delete Subrecord, and Add Subrecord. When the form includes several subform instances, the action will apply to the subform that has the focus.

Subformulários em página

Page subforms can display the data of the current subrecord or any type of pertinent value depending on the context (variables, pictures, and so on). One of the main advantages of using page subforms is that they can include advanced functionalities and can interact directly with the parent form (widgets). Page subforms also have their own specific properties and events; you can manage them entirely by programming.

The page subform uses the input form indicated by the Detail Form property. Unlike a list subform, the form used can come from the same table as the parent form. Também é possível utilizar um formulário projeto. When executed, a page subform has the same standard display characteristics as an input form.

Os widgets 4D são objetos compostos predefinidos com base em subformulários de página. They are described in detail in a separate manual, 4D Widgets.

Utilizar a variável ou expressão ligada

You can bind a variable or an expression to a subform container object. This is very useful to synchronize values from the parent form and its subform(s).

The variable bound to a page subform lets you link the parent form and subform contexts to put the finishing touches on sophisticated interfaces. For example, imagine a subform representing a dynamic clock, inserted into a parent form containing an enterable variable of the Time type:

• Define a bound variable or expression of a scalar type and call the OBJECT Get subform container value and OBJECT SET SUBFORM CONTAINER VALUE commands to exchange values when On Bound Variable Change or On Data Change form events occur. Esta solução é recomendada para sincronizar um único valor.
• Define a bound variable or expression of the object type and use the Form command to access its properties from the subform. Esta solução é recomendada para sincronizar vários valores.

Sincronização do formulário principal e do subformulário (valor único)

Binding the same variable or expression to your subform container and other objects of the parent form lets you link the parent form and subform contexts to put the finishing touches on sophisticated interfaces. Imagine a subform that contains a clock displaying a static time, inserted into a parent form containing an input area:

Both objects (time variable and subform container) have the same variable name. It can be a variable (e.g. parisTime), or an expression (e.g. Form.parisTime).

info

To display a static time, you must use the appropriate data type for the variable or expression:

• If you use a variable (e.g. parisTime), it must be of the text or time type.
• If you use an expression (e.g. Form.myValue), it must contain a text value.

O valor do texto deve ter o formato "hh:mm:ss".

If you "manually" move the hands of the clock, this also generates the On Data Change form event in the object method of the clockValue variable in the subform.

Updating subform contents

Case 1: The value of the parent form variable or expression is modified and this modification must be passed on to a subform.

In our example, the time of ParisTime changes to 12:15:00, either because the user entered it, or because it was updated dynamically (via the Current time command for example). Case 1: The value of the parent form variable is modified and this modification must be passed on to the subform.

O seguinte código é executado:

// Subform form method If (Form event code=On Bound Variable Change) //bound variable or expression was modified in the parent form
    Form.clockValue:=OBJECT Get subform container value //synchonize the local value End if

Ele atualiza o valor de Form.clockValue no subformulário:

The On Bound Variable Change form event is generated:

• as soon as a value is assigned to the variable of the parent form, even if the same value is reassigned,
• se o subformulário pertence à página formulário atual ou à página 0.

Note that, as in the above example, it is preferable to use the OBJECT Get pointer command which returns a pointer to the subform container rather than its variable because it is possible to insert several subforms in the same parent form (for example, a window displaying different time zones contains several clocks).

When the parent form is executed, the developer must take care to synchronize the variables using appropriate form events. Two types of interactions can occur: form to subform and vice versa.

• Use of the "subform" parameter with the OBJECT Get name command to specify the subform object and the OBJECT Get pointer command.
• Assigning the value to the variable generates the On Data Change form event in the object method of the parent subform container, which lets you perform any type of action.

Updating parent form contents

Caso 2: o conteúdo do subformulário é modificado e esta modificação deve ser transmitida ao formulário principal.

This triggers the On Data Change form event inside the clock object (this event must be selected for the object), which updates the Form.parisTime value in the main form. Inside the subform, the button changes the value of the Form.clockValue expression of type Text attached to the clock object.

O seguinte código é executado:

// subform clock object method If (Form event code=On Data Change) //whatever the way the value is changed
    OBJECT SET SUBFORM CONTAINER VALUE(Form.clockValue) //Push the value to the container End if

Everytime the value of Form.clockValue changes in the subform, parisTime or Form.parisTime in the subform container is also updated.

If the variable value is set at several locations, 4D uses the value that was loaded last. It applies the following loading order: 1-Object methods of subform 2-Form method of subform 3-Object methods of parent form 4-Form method of parent form

Sincronização formulário principal e do subformulário (valores múltiplos)

4D automatically binds an object (C_OBJECT) to each subform. The contents of this object can be read and/or modified from within the context of the subform, allowing you to share values in a local context.

In all cases, the object is returned by the Form command, which can be called directy the subform (using a pointer is useless). Since objects are always passed by reference, if the user modifies a property value in the subform, it will automatically be saved in the object itself. On the other hand, if a property of the object is modified by the user in the parent form or by programming, it will be automatically updated in the subform. Não é necessária qualquer gestão de eventos.

For example, in a subform, inputs are bound to the Form object properties (of the subform form):

No formulário pai, o subformulário é apresentado duas vezes. Each subform container is bound to an expression which is a property of the Form object (of the parent form):

The button only creates mother and father properties in the parent's Form object:

//Add values button object method Form.mother:=New object("lastname"; "Hotel"; "firstname"; "Anne")
Form.father:=New object("lastname"; "Golf"; "firstname"; "Félix")

When you execute the form and click on the button, you see that all values are correctly displayed:

If you modify a value either in the parent form or in the subform, it is automatically updated in the other form because the same object is used:

Utilização de ponteiros (compatibilidade)

In versions prior to 4D v19 R5, synchronization between parent forms and subforms was handled through pointers. Por exemplo, para atualizar um objeto subformulário, você pode chamar o seguinte código:

// Subform form method If (Form event code=On Bound Variable Change) 
    ptr:=OBJECT Get pointer(Object subform container) 
    clockValue:=ptr-> End if

This principle is still supported for compatibility but is now deprecated since it does not allow binding expressions to subforms. It should no longer be used in your developments. In any cases, we recommend to use the Form command or the OBJECT Get subform container value and OBJECT SET SUBFORM CONTAINER VALUE commands to synchronize form and subform values.

Programação entre formulários avançada

Communication between the parent form and the instances of the subform may require going beyond the exchange of a value through the bound variable. In fact, you may want to update variables in subforms according to the actions carried out in the parent form and vice versa. If we use the previous example of the "dynamic clock" type subform, we may want to set one or more alarm times for each clock.

4D implementou os seguintes mecanismos para atender a essas necessidades:

• Calling of a container object from the subform using the CALL SUBFORM CONTAINER command,
• Execution of a method in the context of the subform via the EXECUTE METHOD IN SUBFORM command.

The GOTO OBJECT command looks for the destination object in the parent form even if it is executed from a subform.

Comando CALL SUBFORM CONTAINER

The CALL SUBFORM CONTAINER command lets a subform instance send an event to the subform container object, which can then process it in the context of the parent form. O evento é recebido no método do objeto contentor. It may be at the origin of any event detected by the subform (click, drag-and-drop, etc.).

O código do evento não tem restrições (por exemplo, 20000 ou -100). You can use a code that corresponds to an existing event (for example, 3 for On Validate), or use a custom code. In the first case, you can only use events that you have checked in the Property List for subform containers. In the second case, the code must not correspond to any existing form event. It is recommended to use a negative value to be sure that this code will not be used by 4D in future versions.

For more information, refer to the description of the CALL SUBFORM CONTAINER command.

Comando EXECUTE METHOD IN SUBFORM

The EXECUTE METHOD IN SUBFORM command lets a form or one of its objects request the execution of a method in the context of the subform instance, which gives it access to the subform variables, objects, etc. This method can also receive parameters. Este método também pode receber parâmetros.

Este mecanismo é ilustrado no diagrama seguinte:

Para mais informações, consultar a descrição do comando EXECUTE METHOD IN SUBFORM.

Propriedades compatíveis

Border Line Style - Bottom - Class - Detail Form - Double click on empty row - Double click on row - Enterable in list - Expression Type - Focusable - Height - Hide focus rectangle - Horizontal Scroll Bar - Horizontal Sizing - Left - List Form - Method - Object Name - Print Frame - Right - Selection mode - Source - Top - Type - Variable or Expression - Vertical Scroll Bar - Vertical Sizing - Visibility - Width