FORMAT

Basic form

FORMAT.

Extras:

1. ... COLOR n     [ON] or   ... COLOR       OFF

2. ... INTENSIFIED [ON] or   ... INTENSIFIED OFF

3. ... INVERSE     [ON] or   ... INVERSE     OFF

4. ... HOTSPOT     [ON] or   ... HOTSPOT     OFF

5. ... INPUT       [ON] or   ... INPUT       OFF

6. ... FRAMES      [ON] or   ... FRAMES      OFF

7. ... RESET

Effect

Sets or modifies the valid output format for list output statements (WRITE, ULINE).

Notes

• The formats set by FORMAT are effective from the next output operation to the list, i.e. from the next WRITE command or from the next new line.
  
• The addition ON for switching on the relevant output format is optional.
  
• You can also set the static additions ON, OFF and n (for COLOR) dynamically with = var (for further information, see end of this documentation).
  
  
  

Addition 1

... COLOR n [ON] or ...COLOR OFF

Effect

Color of line background. n can have the following values:

OFF
or COL_BACKGROUND
Background (GUI-specific)

1
or COL_HEADING
Headers (grayish blue)

2
or COL_NORMAL
List body (bright gray)

3
or COL_TOTAL
Totals (yellow)

4
or COL_KEY
Key columns (bluish green)

5
or COL_POSITIVE
Positive threshold value (green)

6
or COL_NEGATIVE
Negative threshold value (red)

7
or COL_GROUP
Control levels (violet)

List of colors.

Note

Every time a new event ( START-OF-SELECTION, TOP-OF-PAGE, ... ) is started, the system setting reverts to COLOR 0.
The additions .. INTENSIFIED and ... INVERSE both affect the color display (see below).

The attribute ...COLOR does not work for lines.

Addition 2

... INTENSIFIED [ON] or ... INTENSIFIED OFF

Effect

Intensified - affects the background color.
Each color exists in a normal (desaturated) and in an intensified (saturated) form. ... INTENSIFIED takes the current background color from the "intensified" palette, while the ... INTENSIFIED OFF uses the "normal" palette.

Note

Every time a new event ( START-OF-SELECTION, TOP-OF-PAGE, ...) is started, the system setting reverts to ... INTENSIFIED.
On a standard background (COLOR COL_BACKGROUND), the foreground color may be affected in certain cases. (Color palette: "output field intensified", IntNorm).
If, for example, you use the addition ... INVERSE, the addition ... INTENSIFIED has no effect.

The attribute ...INTENSIFIED does not work for lines.

Addition 3

... INVERSE [ON] or ... INVERSE OFF

Effect

Inverse - affects the background and foreground colors.
Each color exists in an inverse form. ... INVERSE takes the current color from the "inverse" palette and uses it as the foreground (font) color. The background (COL_BACKGROUND) then has no color. ... INVERSE OFF switches off the inverse display.

Note

Every time a new event ( START-OF-SELECTION, TOP-OF-PAGE, ...) is started, the system switches off ... INVERSE.
If the use of ... INVERSE results in the same background and foreground colors (COLOR OFF INVERSE), the background color and the foreground color are merely reversed.
When you use the inverse display, the addition ... INTENSIFIED has no effect.

The attribute ...INVERSE does not work for lines.

Addition 4

... HOTSPOT [ON] or ... HOTSPOT OFF

Effect

Affects the display format of the mouse pointer and the effect of the single mouse-click:
If you drag the mouse pointer over list areas which are output with the format ...HOTSPOT (lines or fields), the mouse pointer switches from its standard display format (usually an arrow) to the format of a hand with an outstretched index finger. If you then click once, the effect is like double-clicking or pressing the function key F2 (AT LINE-SELECTION).

Note

The addition ...HOTSPOT has no effect on input fields.

Addition 5

... INPUT [ON] or ... INPUT OFF

Effect

Determines whether the user can enter data. You can change the contents of list lines output with the format ... INPUT on the screen. You can also print out the change or process it further by using READ LINE in interactive events.
... INPUT OFF reverses the ready for input status.

Note

Every time a new event ( START-OF-SELECTION, TOP-OF-PAGE, ...) is started, the system switches off ... INPUT.
The additions ... COLOR, ... INVERSE and ... HOTSPOT have no effect on input fields.
The addition ... INTENSIFIED affects the background color (color palette "input field" or "output field intensified").

The attribute ... INPUT causes lines to be displayed character-by-character and ready for input (| or -).

Blank lines are displayed only if you have specified BLANK LINES ON beforehand. To make blank INPUT fields visible on blank lines, you can use the SET BLANK LINES statement.

Addition 6

... FRAMES [ON] or    ... FRAMES OFF

Effect

Effects lines and borders. In the default setting FRAMES ON, touching lines are connected to form border components such as corners, T sections or crosses. This may produce undesired results on print lists. Therefore, you can use FRAMES OFF to prevent lines from being connected.

Notes

• Connecting lines to form borders is based on the automatic insertion of special lines at the appropriate positions. You can find all special lines available in the statement pattern for the WRITE statement in the ABAP Editor by choosing Line.
  
• If you use the format FRAMES OFF in an individual WRITE statement, the system only avoids the special lines of this statement but not those of the neighboring lines.
  
• The format FRAMES OFF only avoids the automatic insertion of special lines but not their explicit use with the addition AS LINE of the statement WRITE. In an individual WRITE statement, you must therefore not use the additions AS LINE and FRAMES OFF simultaneously.
  
  
  

Addition 7

... RESET

Effect

Resets all formats (color, intensified, inverse, hotspot and input).
This corresponds to the command:

FORMAT COLOR OFF
       INTENSIFIED OFF
       INVERSE OFF
       HOTSPOT OFF
       INPUT OFF
       FRAMES ON.

All formats except INTENSIFIED are set to their default value. INTENSIFIED is set to OFF. The default value is ON.

Example

FORMAT INTENSIFIED INPUT.
WRITE 5 'JOHN'.
FORMAT INPUT OFF.
WRITE 40 'CARL'COLOR COL_GROUP.

produces the following output:
                 ....+....10...+....20...+....30...+....40...+
                 JOHN                               CARL
ready for input: <------>
intensified:     <------------------------------------------>
color:                                                 <--->

From the beginning of the line to the last character of 'JOHN', the list is ready to accept input and is thus displayed in intensified form ("input field intensified" = InputInt).
From column 9 (i.e. after the 'N' of 'JOHN'), the list line is also intensified but no longer ready for input.
'CARL' is output from line 40, together with a colored bar (color COL_GROUP = 7 from the palette "color intensified"). The font color is the color "output field intensified" (ProtInt). The intensified line display ends with the last character of 'CARL'.

Notes

• If the formats apply only to the output of a single field, you can set the same (and other) parameters as additions to the WRITE statement.
  
  
• If you want to display different formats on the screen, there are no reserved characters, i.e. you may output 2 fields with different formats one directly after the other (without gaps).
  
  
• You can also set the static additions ON, OFF and n (for COLOR) dynamically with = var which always interprets the contents of var as a number. Values other than zero are used as ON or color number, zero works like OFF.
  For color numbers less than zero or greater than 7, the result is not defined. In Unicode programs, the values of the type of var must be convertible into a number (see Numeric Data Objects).
  Recommended data type: I(nteger)
  If you can specify a static addition for FORMAT, you should do so; static specifications improve performance and program readability.
  
  
  

Example

DATA C TYPE I VALUE 5.
FORMAT INTENSIFIED ON COLOR = C.

Additional help

Formatting of the Output