EDIT_TEXT_FORMAT_RTF SAP Function module - Editor WinWord call for standard texts of type RTF (Rich Text Format)

EDIT_TEXT_FORMAT_RTF is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name EDIT_TEXT_FORMAT_RTF into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SMSD
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM EDIT_TEXT_FORMAT_RTF - EDIT TEXT FORMAT RTF

CALL FUNCTION 'EDIT_TEXT_FORMAT_RTF' "Editor WinWord call for standard texts of type RTF (Rich Text Format)
  EXPORTING
    header =                    " thead         Text header of text to be edited
    control =                   " ttxct         Control structure for edit mode
  IMPORTING
    newheader =                 " thead         Text header (return values)
    newcontrol =                " ttxct         Control structure (return values)
  TABLES
    lines =                     " tline         Text lines
* CHANGING
*   doc_content =               " table
*   doc_size =                  " i
  EXCEPTIONS
    COMMUNICATION = 1           "
    TEXTFORMAT = 2              "
    .  "  EDIT_TEXT_FORMAT_RTF

ABAP code example for Function Module EDIT_TEXT_FORMAT_RTF

The ABAP code below is a full code listing to execute function module EDIT_TEXT_FORMAT_RTF including all data declarations. The code uses the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the original method of declaring data variables up front. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8).

DATA:
ld_newheader  
 
 TYPE THEAD
,
ld_newcontrol  
 
 TYPE TTXCT
,
it_lines  
 
 TYPE STANDARD TABLE OF TLINE,"TABLES PARAM
wa_lines
 
 LIKE LINE OF it_lines
.


DATA(ld_doc_content) = 'Check type of data required'.

DATA(ld_doc_size) = 'Check type of data required'.

DATA(ld_header) = 'Check type of data required'.

DATA(ld_control) = 'Check type of data required'.
 

"populate fields of struture and append to itab
append wa_lines to it_lines.
.

CALL FUNCTION 'EDIT_TEXT_FORMAT_RTF'
  EXPORTING
    header =                     ld_header
    control =                    ld_control
  IMPORTING
    newheader =                  ld_newheader
    newcontrol =                 ld_newcontrol
  TABLES
    lines =                      it_lines
* CHANGING
*   doc_content =                ld_doc_content
*   doc_size =                   ld_doc_size
  EXCEPTIONS
    COMMUNICATION =              1
    TEXTFORMAT =                 2
    .  "  EDIT_TEXT_FORMAT_RTF

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_doc_content
 
 TYPE TABLE ,
ld_newheader
 
 TYPE THEAD ,
ld_header
 
 TYPE THEAD ,
it_lines
 
 TYPE STANDARD TABLE OF TLINE ,
wa_lines
 
 LIKE LINE OF it_lines,
ld_doc_size
 
 TYPE I ,
ld_newcontrol
 
 TYPE TTXCT ,
ld_control
 
 TYPE TTXCT .


ld_doc_content = 'Check type of data required'.
ld_header = 'Check type of data required'. 

"populate fields of struture and append to itab
append wa_lines to it_lines.
ld_doc_size = 'Check type of data required'.
ld_control = 'Check type of data required'.