EDIT_TEXT_INLINE

Use

In an application it may be necessary to display or edit the first few lines of a text in any screen. To do this, the module EDIT_TEXT_INLINE can be used.

The text lines passed in table INLINES are merged with the lines in table LINES. The number of lines is determined via the parameter INLINE_COUNT. If necessary, it is possible to branch to the fullscreen editor. In this case, the function module behaves like EDIT_TEXT.

When the function has been carried out, table INLINES is filled with the appropriate number of lines from LINES. The parameter SAVE can be used to specify whether the module SAVE_TEXT should be called automatically for line changes.

Output of the text lines from table INLINES to the screen must be carried out by the application program, as well as returning the changed lines after Enter has been selected. Only the editing options provided for general screen fields are available on the application screen.

The function module is called at the PBO event.

Function call:

CALL FUNCTION 'EDIT_TEXT_INLINE'
EXPORTING
        DISPLAY         = SPACE
        EDITOR_TITLE    = SPACE
        HEADER          =
        INLINE_COUNT    =
        SAVE            = 'X'
        TEXTSCREEN      = SPACE
        CONTROL         = SPACE
        PROGRAM         = SPACE
IMPORTING
        FUNCTION        =
        NEWHEADER       =
        RESULT          =
TABLES
        INLINES         =
        LINES           =
EXCEPTIONS
        ID              =
        LANGUAGE        =
        LINESIZE        =
        NAME            =
        OBJECT          =

Export parameters:

DISPLAY	This parameter determines whether the text editor is called in display mode or change mode. In display mode, the user cannot edit the text. Possible values: 'X' Display Mode ' ' change mode Default value: SPACE
EDITOR_TITLE	The title specified is displayed in the title bar of the text editor window, in addition to other headings generated by SAPscript. Reference field: TTXIT-TDTEXT Default value: SPACE
HEADER	Enter the structure that contains the text header of the text to be edited. Structure: THEAD
INLINE_COUNT	Enter the number of text lines you want the system to pass from table LINES to table INLINES. The system always starts at the beginning of table LINES. This value corresponds to the number of text lines displayed on a screen.
SAVE	Use this parameter to determine whether the system calls SAVE_TEXT after saving the text in the editor. If you want to suppress this call, the application program must lateron call the function module SAVE_TEXT itself. In both cases, the changed text lines are returned to the application program. Possible values: 'X' call SAVE_TEXT ' ' suppress SAVE_TEXT Default value: 'X'
TEXTSCREEN	The parameter determines whether the text editor should be called after adjustment of the INLINE lines. Possible values: ' ' Text editor is not called 'X' Text editor is called Default value: SPACE
CONTROL	Use the parameter CONTROL to set certain attributes of the SAPscript Editor. The attributes are described in the fields of the structure ITCED. Structure: ITCED Default value: SPACE
PROGRAM	Use this parameter to determine the program whose work areas the system uses to replace the values of the program symbols. If you omit this parameter, the system uses the first program called to search for the field values (SY-CPROG). The form processor replaces program symbols in the print view only, but not in the editor itself. Reference field: SY-REPID Default value: SPACE

Import parameter:

FUNCTION

The parameter returns the processing status of the text module for the current editor call.

Possible values:

' ' No action
'I' Text module was created
'U' Text module was updated
'D' Text module was deleted

NEWHEADER

Return parameter for the text header. Due to certain operations in the editor, also fields in the text header are changed.

Structure: THEAD

RESULT

The SAPscript editor returns status information to the calling program via this parameter. This information is described by the fields of the structure ITCER.

Structure: ITCER

Table parameters:

INLINES

Contains the first INLINE_COUNT lines of table LINES. The application program must transfer these lines at the PAI event to the corresponding fields of the appropriate application screen. And, at the PBO event, it must return the lines from the screen fields to the table before calling the function module.

Structure: TLINE

LINES

Contains the table with the lines of the text module.

Structure: TLINE

Exceptions:

ID	The text ID specified in the parameter ID or text header, field TDID, does not exist in table TTXID. It must be defined there with the text module object.
LANGUAGE	In the field TDSPRAS of the header a language key is specified which is not defined in table T002.
LINESIZE	The field TDLINESIZE of the text header contains a line width less than 0 or greater than 132.
NAME	The parameter NAME or the field TDNAME of the text header contain the name of a text module that does not correspond to the SAPscript conventions. Possible errors: Field contains only blanks Field contains the invalid characters '*' or ','.
OBJECT	The parameter OBJECT or the field TDOBJECT in the text header contain the name of a text object that is not defined in table TTXOB.