Format

<< Click here to display Table of Contents >> RS/2 functions and procedures:

Format

Contents

(AttributeList,FormattedText:list):number;

Function

FORMAT and TAB_FORMAT are analogues of the IDF Rich Text container used in the dynamic composition number of text paragraphs.
ATTRIBUTELIST specifies the overall text attributes as an ordered list of up to 13 properties as follows:

Left, Top, Width, Height, Padding, BorderWidth, Rotate, LineJoin, LineEnd, BorderStyle, Borders, BorderColor, BGColor

[600, 600, 900, 1050, 0, 0, 0, "round", "round", "solid", "T,L", "Black", "#408000"]

FORMATTEDTEXT list consists of "commandkey:value" pairs expressed as strings.

["text:hello","break:","text:world"]

Command key	Description	Example
text:	Sequence	text:hello world
font:	Font face name	font:Arial
size:	Point size	size:12
break:	Argument ignored. Insert line break	break:
blank:	Argument ignored. Insert blank line	blank:
align:	Set text alignment. LJ, RJ, CJ, or FILL	align:lj
bold:	Engage bold font	bold:
italic:	Engage italic font	italic:
underline:	Engage text	underline:
color:	Engage specified color	color:#0000ff

(S:string;N:number):string;

Function

FORMATFLOAT uses the string S to specify how the floating-point number N should be displayed. S may take these values:

0	Forces digit display or 0
#	Optional digit display
,	Forces display of thousands
.	Forces display of decimals
E+	Forces signed exponent display
E-	Optional sign exponent display
;	Separator of +ve and -ve and zero values

This table shows the effect of different strings on the way numbers are displayed.

string	N=1234	N=-1234	N=0.5	N=0
'0'	1234	-1234	1	0
'0.00'	1234.00	-1234.00	0.50	0.00
'#.##'	1234	-1234	.5
'#,##0.00'	1,234.00	-1,234.00	0.50	0.00
'#,##0.00;(#,##0.00)'	1,234.00	(1,234.00)	0.50	0.00
'#,##0.00;;Zero'	1,234.00	-1,234.00	0.50	Zero
'0.000E+00'	1.234E+03	-1.234E+03	5.000E-01	0.000E+00
'#.###E-0'	1.234E3	-1.234E3	5E-1

(PointSize:number;FontName,Style:string);

Procedure

EscapeE only

FONT engages the specified font.

Font(12,'Arial','bold');

Line example, Table example: Basic.

See also TEXT and EXTENT procedures, below.

(X,Y:number;S:string)

Procedure

EscapeE only

TEXT draws text S on page at X,Y (measured in pixels at 600dpi).

Line example, Rotate example, Table example: Variable data.

See also FONT procedure, above.

(Angle: number);

Procedure

EscapeE only.

ROTATE specifies the ANGLE in degrees counter-clockwise for TEXT display.

Rotate example, Line example.

(S:string;var Ascent,Descent,Width:number);

Procedure

EscapeE only

EXTENT procedure returns text metrics for the string S in pixels at 600dpi.

ASCENT variable gives the font maximum height above the baseline.
DESCENT variable gives the text maximum depth below the baseline.
WIDTH variable gives the overall length of the string.

(Format:string):string;

Function NOW specifies current date and time in one of these Format options:
y	Year; last 2 digits
yy	Year; last 2 digits
yyyy	Year as 4 digits
m	Month number; no-leading 0
mm	Month number as 2 digits
mmm	Month using ShortMonthNames (Jan)
mmmm	Month using LongMonthNames (January)
d	Day number; no-leading 0
dd	Day number as 2 digits
ddd	Day using ShortDayNames (Sun)
dddd	Day using LongDayNames (Sunday)
ddddd	Day in ShortDateFormat
dddddd	Day in LongDateFormat
c	Use ShortDateFormat + LongTimeFormat
h	Hour number; no-leading 0
hh	Hour number as 2 digits
n	Minute number; no-leading 0
nn	Minute number as 2 digits
s	Second number; no-leading 0
ss	Second number as 2 digits
z	Millisecond number; no-leading 0s
zzz	Millisecond number as 3 digits
t	Use ShortTimeFormat
tt	Use LongTimeFormat
am/pm	Use after h : gives 12 hours + am/pm
a/p	Use after h : gives 12 hours + a/p
ampm	As a/p but TimeAMString,TimePMString
/	Substituted by DateSeparator value
:	Substituted by TimeSeparator value
NOW('ddd mmm yyyy hh:mm:ss.zzz'); Column example