PRINT_FORMAT

The PRINT_FORMAT function is identical to the PRINT function with the addition of a STRING parameter to specify how the text should be formatted. Note that the formatting is only applied when running code in a graphical environment, e.g. XJRunner, XJDeveloper or XJIntegration using the XJTAG output box) and not from the command line.

PRINT_FORMAT( STRING format, [ INT expression | STRING expression ] , ... )

Example

INT result;

// Define a style for tracing; the size is not set and so is inherited from the application's options
STRING traceStyle := "font=Courier New,colour=grey";

IF DEBUG THEN PRINT_FORMAT(traceStyle, "IC1.Test starting\n"); END;
CALL("IC1", "Test")()(result);
IF DEBUG THEN PRINT_FORMAT(traceStyle, "IC1.Test finished\n"); END;

IF result != 0 THEN
  PRINT_FORMAT("colour=red,size=150%", "IC1 Test Failed\n");
END;

Format strings

The format string contains a comma separated list of formatting options. The available formatting options are:

font

Specifies the name of the typeface to use to display the text. The name is not case sensitive. If the font name is not found, then the system will silently ignore the error and use the default font that has been selected in the application options.

size

Specifies the size of the text to display. See below for the different ways this can be specified.

colour or color

Specifies the colour of the text. See below for the different ways this can be specified.

Any item that is not specified is inherited from the default settings that have been selected in either XJRunner or XJDeveloper.

Standard styles

The standard Globals.xje file that is included automatically in all new projects defines three constant styles:

ERROR_STYLE

For displaying error messages from XJEase code; the current value is "colour=red".

WARNING_STYLE

For displaying warnings from XJEase code; the current value is "colour=darkorange".

DEBUG_STYLE

For displaying debug output; the current value is "colour=darkgrey".

Font size

There are three ways that font size can be specified:

In points

This is the measurement of font size most widely used in other applications under Windows. Specify a number followed by pt, e.g. size=16pt.

In pixels

Make the font a particular size in pixels. px, e.g. size=20px.

Relative size

Make the font proportional in size to the default font size, e.g size=150% would make the text 50% bigger than the default font. Using relative sizes like this has the advantage that you can increase the default size in the application and all the text will scale accordingly.

Colour

There are two ways that colour can be specified:

Named colours

There are a number of pre-defined, named colours that can be used, which are listed in the table below. The name is not case sensitive.

RGB value

A hexadecimal value prefixed with a '#' that gives the red, green and blue colour values, with each component ranging from 0x00 to 0xff. For example, #000000 is black, #ff0000 is pure red, #00ff00 is pure green, #0000ff is pure blue and #ffffff is white.