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 specifies how to merge the text lines to be output with any existing contents in the window. In this case, 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 DELETE in the TOP area (headings) takes effect only on the next page. You can no longer delete any heading from the TOP area after outputting text to the BODY area.
Default value: 'SET' |
TYPE |
The system interprets this parameter only for output to the main window. 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 parameters:
PENDING_LINES |
If a text is output to the BOTTOM area of the main window (TYPE = 'BOTTOM'), there may be not enough space left on the current output page. The system then internally flags this text for output into the BOTTOM area of the next page. The actual output is pending. 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 that the system could not find. Possible reasons:
An element refers to a window, and the specified window does not contain the element. If no window is specified, the system searches for the element in the main window.
|
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:
|
UNOPENED |
The current form function could not be executed, since the form output was no yet initialized using OPEN_FORM. |
UNSTARTED |
No form was opened yet. Possible reasons:
|
WINDOW |
The form window specified in parameter WINDOW does not exist in the current form. Possible reasons:
|