WRITE_FORM

Use

The system outputs the form element specified in parameter ELEMENT into the currently opened form.

In the parameter WINDOW you can specify the name of a window for the output. Remember that the form element must be defined in this window. The parameter FUNCTION determines how to merge the text lines to be output with any existing contents in the window. There are differences between the different window types or areas.

Function call:

CALL FUNCTION 'WRITE_FORM'
        EXPORTING
                ELEMENT         = SPACE
                WINDOW          = 'MAIN'
                FUNCTION        = 'SET'
                TYPE            = 'BODY'
        IMPORTING
                PENDING_LINES   =
        EXCEPTIONS
                ELEMENT         =
                FUNCTION        =
                TYPE            =
                UNOPENED        =
                UNSTARTED       =
                WINDOW          =

Export parameters:

ELEMENT	Specify the name of the text element you want to output into the form window specified in the parameter WINDOW. The element must be defined in that form window. If you specify no element, the system uses the default element, if one is defined in the form. Default value: SPACE
WINDOW	Specify the name of the window into which you want to output the form element specified in the parameter ELEMENT. Default value: 'MAIN'
FUNCTION	The parameter determines how to output the text element into the respective window. The output type depends on the window type and area: Window type: MAIN, area BODY 'SET' append to previous output 'APPEND' same as SET 'DELETE' no effect Window type MAIN, areas TOP and BOTTOM; all other windows: 'SET' delete old window or area contents and output the element 'APPEND' append the element to the existing elements 'DELETE' delete the specified element from the window or area Caution DELETE in the TOP area (headings) takes effect only on the next page. You can no longer delete a heading in the TOP area after writing text into the BODY area. Default value: 'SET'
TYPE	The system interprets this parameter only for output to the main window (WINDOW = 'MAIN'). The parameter determines the area of the main window into which you want to output the element. Possible values: 'TOP' header area 'BODY' main area 'BOTTOM' footer area Default value: 'BODY'

Import parameter:

PENDING_LINES

If a corresponding text is output to the BOTTOM area of the main window (TYPE = BOTTOM), it is possible that this will have no space left on the current output page. It is therefore marked internally only for the BOTTOM output of the next page. The actual output is therefore still due (hangs).

If output is pending, the parameter PENDING_LINES contains 'X', and the print program can react accordingly. For example, an explicit page break at the text end (NEW-PAGE) could implicitly trigger the pending BOTTOM output on the next page.

Exceptions:

ELEMENT	The parameter ELEMENT contains the name of a form element which could not be found. Possible causes: The element is not available. An element is window-specific and the element was not found in the specified window. If no window name was specified, the element is found in the MAIN window my default. A window was specified which was not defined in the form. The form version, which contains the text element in the required form window, is not active.
FUNCTION	The function specified in parameter FUNCTION is unknown. For this parameter, the following values are allowed: SET APPEND DELETE
TYPE	The type of window area specified in parameter TYPE is invalid. Depending on the window type, these entries are valid: BODY for all windows TOP only for the MAIN window BOTTOM only for the MAIN window
UNOPENED	The current form function could not be executed as the form output was not initialized with OPEN_FORM.
UNSTARTED	A layout set was not opened. Possible causes: The form processing was started using OPEN_FORM without specifying a form name, but no form was opened yet using START_FORM. The layout set last used was concluded with END_FORM but a new layout set was not opened with START_FORM. The last filled page of the current form has no subsequent page. In this case, the system automatically terminates form printing after this page. You need no explicit END_FORM call. In the current form, no page contains a main window, but a text element shall be output in the main window. However, a call to output a text element in the MAIN window is nevertheless made.
WINDOW	The form window specified in the parameter WINDOW does not exist in the current form. Possible causes: The window name was entered incorrectly. The form version with the specified window is not active.