|
|
|
|
PROCEDURE OpenReport
(VAR ReportHandle : HtmlHandleType;
CONST FileName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
OpenReport - Open an HTML file for writing.
This procedure allows the user to open an HTML file for output.
The routine returns a handle that is used later by the routines
of the HTML package. This allows multiple HTML files to be open
if desired.
CALLING SEQUENCE -
OpenReport (ReportHandle, FileName, Error);
ENTRY -
FileName : ARRAY OF CHAR
The name of the destination HTML file. If this file exists
it will be overwritten.
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportTitle
(VAR ReportHandle : HtmlHandleType;
CONST Title : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportTitle - Set the HTML Page Title.
This procedure sets a page title that is usually displayed in the browser's
header and is not displayed in the page.
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportTitle (ReportHandle, Title, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Title : ARRAY OF CHAR
The HTML title line.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportBackgroundImage
(VAR ReportHandle : HtmlHandleType;
CONST BgFile : ARRAY OF CHAR;
CONST Fixed : BOOLEAN;
CONST RepeatVal : HtmlRepeatType;
CONST vPos : ARRAY OF CHAR;
CONST hPos : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportBackgroundImage - Set the HTML Background image.
This procedure sets the background image. The input is a file name of the image
and then parameters that direct how that image is displayed on the page.
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportBackgroundImage (ReportHandle, BgFile, Fixed,
RepeatVal, vPos, hPos, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
BgFile : ARRAY OF CHAR
File name of an image to be tiled behind the page
Fixed : boolean
Background scroll feature (TRUE = fixed or FALSE = scroll).
RepeatVal : HtmlRepeatType
Background repeat indicator
REPEATXY - Repeat image in both the x and y direction (default)
REPEATX - Repeat in the x direction only
REPEATY - Repeat in the y direction only
NOREPEAT - Do not repeat
vPos : ARRAY OF CHAR
Vertical image position from left (ie. 10%, 12px, top)
hPos : ARRAY OF CHAR
Horizontal image position from top (ie. 10%, 12px, top)
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportBackgroundColor
(VAR ReportHandle : HtmlHandleType;
CONST Color : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportBackgroundColor - Set the HTML page background color.
This procedure sets the background color. Default = WHITE.
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportBackgroundColor (ReportHandle, Color, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportActiveLinkColor
(VAR ReportHandle : HtmlHandleType;
CONST Color : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportActiveLinkColor - Set the HTML active link color.
This procedure sets color of an active link. DEFAULT = FUCHSIA
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportActiveLinkColor (ReportHandle, Color, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportLinkColor
(VAR ReportHandle : HtmlHandleType;
CONST Color : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportLinkColor - Set the HTML Link color.
This procedure sets the color of links on the page. DEFAULT = RED
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportLinkColor (ReportHandle, Color, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportVisitedLinkColor
(VAR ReportHandle : HtmlHandleType;
CONST Color : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportVisitedLinkColor - Set the HTML visited link color.
This procedure sets the color of a link that has been visited. DEFAULT = MAROON
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportVisitedLinkColor (ReportHandle, Color, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportHoverLink
(VAR ReportHandle : HtmlHandleType;
CONST Color : ARRAY OF CHAR;
CONST cursor : HtmlCursorType;
VAR Error : HtmlErrorType);
(**
SetReportHoverLink - Set the HTML hover link color and cursor.
This procedure sets the color of a link that has been visited. DEFAULT = MAROON
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportHoverLink (ReportHandle, Color, CursorType, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
CursorType : HtmlCursorType
Enter the type of hover cursor
(CURSORAUTO, CROSSHAIR, DEFAULT, HAND, MOVE, ERESIZE,
NERESIZE, NWRESIZE, NRESIZE, SERESIZE, SWRESIZE, SRESIZE,
WRESIZE, TEXT, WAIT, HELP);
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportTextColor
(VAR ReportHandle : HtmlHandleType;
CONST Color : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportTextColor - Set the HTML default text color.
This procedure sets default text color. DEFAULT = BLACK The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportTextColor (ReportHandle, Color, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportFont
(VAR ReportHandle : HtmlHandleType;
CONST size : ARRAY OF CHAR;
CONST Family : ARRAY OF CHAR;
CONST Bold : BOOLEAN;
CONST Italic : BOOLEAN;
CONST SmallCaps : BOOLEAN;
VAR Error : HtmlErrorType);
(**
SetReportFont - Set the HTML default font.
This procedure sets default Font.
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportFont (ReportHandle, Size, Family, Bold, Italic, SmallCaps, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Size : ARRAY OF CHAR
The Font size can be pt size (12pt or one of several names (large, small, etc see HTML Ref).
Family : ARRAY OF CHAR
The Font family name (ie. "New Times Roman").
Bold : BOOLEAN
Set True for bold.
Italic : BOOLEAN
Set True for italic.
Smallcaps : BOOLEAN
Set True for small capital letters.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportMargins
(VAR ReportHandle : HtmlHandleType;
CONST Left : ARRAY OF CHAR;
CONST Right : ARRAY OF CHAR;
CONST Top : ARRAY OF CHAR;
CONST Bottom : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportMargins - Set the HTML Report margins.
This procedure sets default margins width.
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportMargins (ReportHandle, Left, Right, Top, Bottom, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Left : ARRAY OF CHAR
The Left margin as length (10px) or percent. If null then auto.
Right : ARRAY OF CHAR
The Right margin as length (10px) or percent. If null then auto.
Top : ARRAY OF CHAR
The Top margin as length (10px) or percent. If null then auto.
Bottom : ARRAY OF CHAR
The Bottom margin as length (10px) or percent. If null then auto.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportAllMargins
(VAR ReportHandle : HtmlHandleType;
CONST All : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportAllMargins - Set the HTML Report margins with one value.
This procedure sets default Margin width for all sides the same.
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportAllMargins (ReportHandle, All, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
All : ARRAY OF CHAR
The Left, Right, Top and Bottom margins as length (10px) or percent.
If null then auto.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportLineProperties
(VAR ReportHandle : HtmlHandleType;
CONST Indent : ARRAY OF CHAR;
CONST JustifySetting : HtmlJustificationType;
CONST height : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportLineProperties - Set the line properties for the report.
This procedure sets the report Line properties.
CALLING SEQUENCE -
SetReportLineProperties (ReportHandle, Indent, Justify, Height, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Indent : ARRAY OF CHAR
Sets the first line indent of a block. (used mostly with paragraph tags.
Justify : HtmlJustificationType
Text justification within enclosing block
LEFT - Justify along left margin
RIGHT - Justify along right margin
CENTER - Center between margins
JUSTIFY - Adjust spacing to justify along both margins
Spacing : ARRAY OF CHAR
Line height. (2pt) if blank then normal
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetReportStyleSheet
(VAR ReportHandle : HtmlHandleType;
CONST StyleSheet : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetReportStyleSheet - Set the HTML style sheet reference.
This procedure sets the file location to an external style sheet.
The routine must be called prior the BeginReport call to have any effect
CALLING SEQUENCE -
SetReportStyleSheet (ReportHandle, StyleSheet, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
StyleSheet : ARRAY OF CHAR
The name of a file that contains the style sheet
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE GetNextClassName
(VAR ReportHandle : HtmlHandleType;
VAR ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
GetNextClassName - Get a sequential class name.
This procedure sets a class name for use in other routines.
The user can use this if they don't want to maintain their own list
of unique class names.
CALLING SEQUENCE -
GetNextClassName (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
ClassName : ARRAY OF CHAR
The variable to receive the class name. (minimum size 7)
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassBackgroundImage
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST BgFile : ARRAY OF CHAR;
CONST Fixed : BOOLEAN;
CONST RepeatVal : HtmlRepeatType;
CONST vPos : ARRAY OF CHAR;
CONST hPos : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassBackgroundImage - Set the Class Background image.
This procedure sets the background image for a block. The input is a file name of the image.
CALLING SEQUENCE -
SetClassBackgroundImage (ReportHandle, ClassName, BgFile, Fixed,
RepeatVal, vPos, hPos, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
BgFile : ARRAY OF CHAR
File name of an image to be tiled behind the page
Fixed : BOOLEAN
Background scroll feature (fixed or scroll).
RepeatVal : HtmlRepeatType
Background repeat indicator
REPEATXY - Repeat image in both the x and y direction (default)
REPEATX - Repeat in the x direction only
REPEATY - Repeat in the y direction only
NOREPEAT - Do not repeat
vPos : ARRAY OF CHAR
Vertical image position from left (ie. 10%, 12px, top)
hPos : ARRAY OF CHAR
Horizontal image position from top (ie. 10%, 12px, top)
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassBackgroundColor
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Color : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassBackgroundColor - Set the class background color.
This procedure sets the background color.
CALLING SEQUENCE -
SetClassBackgroundColor (ReportHandle, ClassName, Color, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassTextColor
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Color : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassTextColor - Set the HTML default text color.
This procedure sets text color for a class.
CALLING SEQUENCE -
SetClassTextColor (ReportHandle, ClassName, Color, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Color : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassFont
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST size : ARRAY OF CHAR;
CONST Family : ARRAY OF CHAR;
CONST Bold : BOOLEAN;
CONST Italic : BOOLEAN;
CONST SmallCaps : BOOLEAN;
VAR Error : HtmlErrorType);
(**
SetClassFont - Set the font for a class.
This procedure sets the class Font.
CALLING SEQUENCE -
SetClassFont (ReportHandle, ClassName, Size, Family, Bold, Italic, SmallCaps, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Size : ARRAY OF CHAR
The Font size can be pt size (12pt or one of several names (large, small, etc see HTML Ref).
Family : ARRAY OF CHAR
The Font family name (ie. "New Times Roman").
Bold : BOOLEAN
Set True for bold.
Italic : BOOLEAN
Set True for italic.
Smallcaps : BOOLEAN
Set True for small capital letters.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassMargins
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Left : ARRAY OF CHAR;
CONST Right : ARRAY OF CHAR;
CONST Top : ARRAY OF CHAR;
CONST Bottom : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassMargins - Set the Class margins.
This procedure sets margin for the block element.
CALLING SEQUENCE -
SetClassMargins (ReportHandle, ClassName, Left, Right, Top, Bottom, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Left : ARRAY OF CHAR
The Left margin as length (10px) or percent. If null then auto.
Right : ARRAY OF CHAR
The Right margin as length (10px) or percent. If null then auto.
Top : ARRAY OF CHAR
The Top margin as length (10px) or percent. If null then auto.
Bottom : ARRAY OF CHAR
The Bottom margin as length (10px) or percent. If null then auto.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassAllMargins
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST All : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassAllMargins - Set the Class margins all the same.
This procedure sets margin for the block element to the same value.
CALLING SEQUENCE -
SetClassAllMargins (ReportHandle, ClassName, All, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Left : ARRAY OF CHAR
The Left, Right, Top and Bottom margins as length (10px) or percent.
If null then auto.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassPadding
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Left : ARRAY OF CHAR;
CONST Right : ARRAY OF CHAR;
CONST Top : ARRAY OF CHAR;
CONST Bottom : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassPadding - Set the Class padding sizes.
This procedure sets padding for the block element.
CALLING SEQUENCE -
SetClassPadding (ReportHandle, ClassName, Left, Right, Top, Bottom, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Left : ARRAY OF CHAR
The Left margin as length (10px) or percent.
Right : ARRAY OF CHAR
The Right margin as length (10px) or percent.
Top : ARRAY OF CHAR
The Top margin as length (10px) or percent.
Bottom : ARRAY OF CHAR
The Bottom margin as length (10px) or percent.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassAllPadding
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST All : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassAllPadding - Set the Class padding sizes for all.
This procedure sets padding for the block element.
CALLING SEQUENCE -
SetClassAllPadding (ReportHandle, ClassName, All, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
All : ARRAY OF CHAR
The margins as length (10px) or percent.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassBorderWidth
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Left : ARRAY OF CHAR;
CONST Right : ARRAY OF CHAR;
CONST Top : ARRAY OF CHAR;
CONST Bottom : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassBorderWidth - Set the Class border width or thickness.
This procedure sets border width for the block element.
CALLING SEQUENCE -
SetClassBorderWidth (ReportHandle, ClassName, Left, Right, Top, Bottom, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Left : ARRAY OF CHAR
The Left margin as length (10px) or percent or key words thick, medium, thin.
Right : ARRAY OF CHAR
The Right margin as length (10px) or percent or key words thick, medium, thin.
Top : ARRAY OF CHAR
The Top margin as length (10px) or percent or key words thick, medium, thin.
Bottom : ARRAY OF CHAR
The Bottom margin as length (10px) or percent or key words thick, medium, thin.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassAllBorderWidth
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST All : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassAllBorderWidth - Set the Class border width or thickness for all.
This procedure sets border width for the block element on all sides.
CALLING SEQUENCE -
SetClassAllBorderWidth (ReportHandle, ClassName, All, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
All : ARRAY OF CHAR
The margins as length (10px) or percent or key words thick, medium, thin.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassBorderStyle
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Left : HtmlBorderStyleType;
CONST Right : HtmlBorderStyleType;
CONST Top : HtmlBorderStyleType;
CONST Bottom : HtmlBorderStyleType;
CONST Collapse : BOOLEAN;
VAR Error : HtmlErrorType);
(**
SetClassBorderStyle - Set the Class border style.
This procedure sets border width for the block element.
CALLING SEQUENCE -
SetClassBorderStyle (ReportHandle, ClassName, Left, Right, Top, Bottom,
Collapse, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Left : HtmlBorderStyleType
The Left margin style
BORDERNONE - No border (default)
SOLID - single line border
DOUBLELINE - double line border
GROOVE - border appears to be scratched into the page
RIDGE - opposite of GROOCE
INSET - border is drawn to make the box look inset into the page
OUTSET - opposite of INSET
Right : HtmlBorderStyleType
The Right margin style (See above).
Top : HtmlBorderStyleType
The Top margin style (See above).
Bottom : HtmlBorderStyleType
The Bottom margin style (See above).
Collapse : BOOLEAN
If set TRUE adjacent borders will collapse together. Useful in tables.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassAllBorderStyle
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST All : HtmlBorderStyleType;
CONST Collapse : BOOLEAN;
VAR Error : HtmlErrorType);
(**
SetClassAllBorderStyle - Set the Class border style for all sides.
This procedure sets border width for the block element.
CALLING SEQUENCE -
SetClassAllBorderStyle (ReportHandle, ClassName, All, Collapse, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
All : HtmlBorderStyleType
The margins style
BORDERNONE - No border (default)
SOLID - single line border
DOUBLELINE - double line border
GROOVE - border appears to be scratched into the page
RIDGE - opposite of GROOCE
INSET - border is drawn to make the box look inset into the page
OUTSET - opposite of INSET
Collapse : BOOLEAN
If set TRUE adjacent borders will collapse together. Useful in tables.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassBorderColor
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Left : ARRAY OF CHAR;
CONST Right : ARRAY OF CHAR;
CONST Top : ARRAY OF CHAR;
CONST Bottom : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassBorderColor - Set the Class border color.
This procedure sets border color for the block element.
CALLING SEQUENCE -
SetClassBorderColor (ReportHandle, ClassName, Left, Right,
Top, Bottom, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Left : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
Right : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
Top : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
Bottom : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassAllBorderColor
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST All : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassAllBorderColor - Set the Class border color for all sides.
This procedure sets border color for the block element.
CALLING SEQUENCE -
SetClassAllBorderColor (ReportHandle, ClassName, All, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
All : ARRAY OF CHAR
Selected color either by keyword (blue) or HEX (#0000FF).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassListStyle
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST BulletType : HtmlListStyleType;
CONST BulletImage : ARRAY OF CHAR;
CONST PosInside : BOOLEAN;
VAR Error : HtmlErrorType);
(**
SetClassListStyle - Set the HTML list style for classname.
This procedure sets the list style for a class name.
CALLING SEQUENCE -
SetClassListStyle (ReportHandle, ClassName, BulletType, BulletImage, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
BulletType : HtmlListStyleType
The bullet style.
For unordered lists use -
DISC - Filled circle (default)
CIRCLE - Hollow circle
SQUARE - Filled in square
For ordered lists use -
DECIMAL - numbers 1,2,3,... (default)
LOWER-ROMAN - roman numerals IntVal,ii,iii,...
UPPER-ROMAN - roman numerals I,II,III,...
LOWER-ALPHA - letters a,b,c,...
UPPER-ALPHA - letters A,B,C,...
For either
LISTNONE - no list marker
IMAGE - use a supplied image
BulletImage : ARRAY OF CHAR
The file name of an image to use for the bullet. The BulletType must be IMAGE.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassTextProperties
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Decoration : HtmlTextDecorType;
CONST SuperSub : HtmlTextVAlignType;
CONST Transform : HtmlTextTransformType;
CONST Spacing : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassTextProperties - Set the text properties for a class.
This procedure sets the class text properties.
CALLING SEQUENCE -
SetClassTextProperties (ReportHandle, ClassName, Decoration, SuperSub, Transform, Spacing, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Decoration : HtmlTextDecorType
Text decoration
DECORNONE - No decoration. Just the text. (default)
UNDERLINE - Place a line under the text
OVERLINE - Place a line over the text
LINETHROUGH - Draw a line through the text
SuperSub : HtmlTextVAlignType
Text vertical alignment
ALIGNNORMAL - Text is placed on the line base (default)
SUPER - Text is superscripted or place above the base
SUB - Text is subscripted or place below the base
Transform : HtmlTextTransformType
Sets the text transformation indicator
TRANSFORMNONE - Leave unchanged (default)
CAPITALIZE - Capitalize first letter of each word
UPPERCASE - Change all letters to uppercase
LOWERCASE - Change all letters to lowercase
Spacing : ARRAY OF CHAR
Spacing between characters. (2pt) if blank then normal
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassLineProperties
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Indent : ARRAY OF CHAR;
CONST Justify : HtmlJustificationType;
CONST height : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassLineProperties - Set the line properties for a class.
This procedure sets the class Line properties.
CALLING SEQUENCE -
SetClassLineProperties (ReportHandle, ClassName, Indent, Justify, Height, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Indent : ARRAY OF CHAR
Sets the first line indent of a block. (used mostly with paragraph tags.
Justify : HtmlJustificationType
Text justification within enclosing block
LEFT - Justify along left margin
RIGHT - Justify along right margin
CENTER - Center between margins
JUSTIFY - Adjust spacing to justify along both margins
Spacing : ARRAY OF CHAR
Line height. (2pt) if blank then normal
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassOverflow
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST overFlow : HtmlOverflowType;
VAR Error : HtmlErrorType);
(**
SetClassOverflow - Set the overflow properties for a block.
This procedure sets the class overflow properties.
CALLING SEQUENCE -
SetClassOverflow (ReportHandle, ClassName, Overflow, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Overflow : HtmlOverflowType
Text overflow property
VISIBLE - Text is written whether inside the box or not
HIDDEN - Text is clipped. Hidden outside the box
SCROLL - Text is scrolled within the box
OVERFLOWAUTO - Browser dependent but probably uses SCROLL
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassPageBreak
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Before : BOOLEAN;
CONST After : BOOLEAN;
VAR Error : HtmlErrorType);
(**
SetClassPageBreak - Set the page break properties for a block.
This procedure sets the class page break properties.
CALLING SEQUENCE -
SetClassPageBreak (ReportHandle, ClassName, Before, After, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Before : BOOLEAN
if true then set page break to always before printing.
After : BOOLEAN
if true then set page break to always before printing.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassCursor
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST CursorType : HtmlCursorType;
VAR Error : HtmlErrorType);
(**
SetClassCursor - Set the cursor type.
This procedure sets the class cursor type used in element.
CALLING SEQUENCE -
SetClassCursor (ReportHandle, ClassName, CursorType, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
CursorType : HtmlCursorType
Specifies the cursor type to use.
(CURSORAUTO, CROSSHAIR, DEFAULT, HAND, MOVE, ERESIZE,
NERESIZE, NWRESIZE, NRESIZE, SERESIZE, SWRESIZE, SRESIZE,
WRESIZE, TEXT, WAIT, HELP);
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassPosition
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST PosType : HtmlPositionType;
CONST Top : ARRAY OF CHAR;
CONST Left : ARRAY OF CHAR;
CONST height : ARRAY OF CHAR;
CONST width : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassPosition - Set the position properties for an item.
This procedure sets the class position properties.
CALLING SEQUENCE -
SetClassPosition (ReportHandle, ClassName, PosType, Top, Left, Height, Width, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
PosType : HtmlPositionType
How to use the positions
STATIC - Positioned using normal flow rules (default)
left and top properties ignored
ABSOLUTE - Position is absolute within containing box
RELATIVE - Box is placed using normal flow rules
and then offset by position numbers
Top : ARRAY OF CHAR
Top position in terms of length, percentage or "auto".
Left : ARRAY OF CHAR
Left position in terms of length, percentage or "auto".
Height : ARRAY OF CHAR
Height position in terms of length, percentage or "auto".
Width : ARRAY OF CHAR
Width position in terms of length, percentage or "auto".
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassBlockFloat
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST FloatVal : HtmlFloatType;
CONST Clear : HtmlClearType;
VAR Error : HtmlErrorType);
(**
SetClassBlockFloat - Set the Block floating parameters.
This procedure sets the class block float and clear prarmeters.
These parameters effect the way text and other blocks float around
each other.
CALLING SEQUENCE -
SetClassBlockFloat (ReportHandle, ClassName, FloatVal, Clear, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
FloatVal : HtmlFloatType
Specifies the float type.
FLOATNONE - Normal flow of objects (default)
FLOATRIGHT - Object floats to the right and text or other
boxes are written on the left
FLOATLEFT - Object floats to the left and text or other
boxes are written on the right
Clear : HtmlClearType
Specifies the clear type.
CLEARNONE - Normal flow of objects (default)
CLEARLEFT - Object will be adjusted so that it clears objects floating left
CLEARRIGHT - Object will be adjusted so that it clears objects floating right
CLEARBOTH - Object will clear any floating object
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassVisibility
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST visible : BOOLEAN;
VAR Error : HtmlErrorType);
(**
SetClassVisibility - Set the Block visibility parameters.
This procedure sets the class block visibility prarmeters.
If set to false the block is not visible but still takes up its
space in the page flow.
CALLING SEQUENCE -
SetClassVisibility (ReportHandle, ClassName, Visible, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Visible : BOOLEAN
False - invisible, True - visible (default).
Clear : HtmlClearType
Specifies the clear type.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetClassClipping
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Left : ARRAY OF CHAR;
CONST Right : ARRAY OF CHAR;
CONST Top : ARRAY OF CHAR;
CONST Bottom : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetClassClipping - Set the Block clipping parameters.
This procedure sets the class clipping area relative to the outer box.
CALLING SEQUENCE -
SetClassClipping (ReportHandle, ClassName, Left, Right, Top, Bottom, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
The class name of the style
Left : ARRAY OF CHAR
Relative length of left clip border. This value can be negative.
Right : ARRAY OF CHAR
Relative length of right clip border. This value can be negative.
Top : ARRAY OF CHAR
Relative length of top clip border. This value can be negative.
Bottom : ARRAY OF CHAR
Relative length of bottom clip border. This value can be negative.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginReport
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
BeginReport - Begin an HTML page.
This procedure allows the user to start an HTML page output and sets the style.
The style routines must have been called prior to this call to change any
defaults or a style sheet defined.
CALLING SEQUENCE -
BeginReport (ReportHandle, Error);
ENTRY -
None
N/A
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE WriteString
(VAR ReportHandle : HtmlHandleType;
CONST line : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
WriteString - Write an output line to the HTML file.
This procedure allows the user to write text to the HTML file.
CALLING SEQUENCE -
WriteString (ReportHandle, Line, Error);
ENTRY -
Line : ARRAY OF CHAR
A string of text to be written in the HTML file at the current location.
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE WriteStyleString
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST line : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
WriteStyleString - Write an styled output line to the HTML file.
This procedure allows the user to write text to the HTML file using
a style class specified. It does this by enclosing the string inside
SPAN tags. The same result can be obtained using:
BeginSpan
WriteString
EndSpan
CALLING SEQUENCE -
WriteStyleString (ReportHandle, ClassName, Line, Error);
ENTRY -
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leaving blank is the same
as calling WriteString.
Line : ARRAY OF CHAR
A string of text to be written in the HTML file at the current location.
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE WriteLine
(VAR ReportHandle : HtmlHandleType;
CONST line : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
WriteLine - Write an output line with CrLf to the HTML file.
This procedure allows the user to write text to the HTML file.
Line end characters are added.
CALLING SEQUENCE -
WriteLine (ReportHandle, Line, Error);
ENTRY -
Line : ARRAY OF CHAR
A string of text to be written in the HTML file at the current location.
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE WriteComment
(VAR ReportHandle : HtmlHandleType;
CONST Comment : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
WriteComment - Write an comment line to the HTML file.
This procedure allows the user to write text to the HTML file that is enclosed
in comment markers so that it is not displayed on the page.
CALLING SEQUENCE -
WriteComment (ReportHandle, Comment, Error);
ENTRY -
Line : ARRAY OF CHAR
A string of text to be written in the HTML file at the current location.
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE WriteLn
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
WriteLn - Write an line break to the HTML file.
This procedure allows the user to write a line break to the HTML file.
CALLING SEQUENCE -
WriteString (ReportHandle, Line, Error);
ENTRY -
None
N/A
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE WriteAnchor
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST line : ARRAY OF CHAR;
CONST Href : ARRAY OF CHAR;
CONST AnchorName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
WriteAnchor - Write an Anchor line to the HTML file.
This procedure allows the user to write text to the HTML file that is enclosed
in anchor markers and has a link associated with it.
CALLING SEQUENCE -
WriteAnchor (ReportHandle, ClassName, Line, Href, AnchorName, Error);
ENTRY -
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
Line : ARRAY OF CHAR
A string of text to be written in the HTML file at the current location.
Href : ARRAY OF CHAR
The HTML link reference.
AnchorName : ARRAY OF CHAR
The link name.
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginParagraph
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginParagraph - Start a new paragraph. Equivalent to a hard return.
This procedure allows the user to issue a paragraph command to the HTML file.
CALLING SEQUENCE -
BeginParagraph (ReportHandle, ClassName, Error);
ENTRY -
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
ReportHandle : RftHandletype
A handle to the HTML file.
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndParagraph
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndParagraph - End a paragraph in the HTML file.
This procedure allows the user to write an end to a paragraph in the HTML file.
CALLING SEQUENCE -
EndParagraph (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE InsertGraphic
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST GraphicFile : ARRAY OF CHAR;
CONST Description : ARRAY OF CHAR;
CONST hSize : ARRAY OF CHAR;
CONST vSize : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
InsertGraphic - Insert a graphic into the HTML file.
This procedure will insert the contents of a graphic file at the
current position.
CALLING SEQUENCE -
InsertGraphic (ReportHandle, ClassName, GraphicFile, Description,
vSize, hSize, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
GraphicFile : ARRAY OF CHAR
The name and if necessary path to a graphic file.
Description : ARRAY OF CHAR
A short description of the graphic.
hSize : ARRAY OF CHAR
Horizontal size to fit the graphic in. To use the default or actual
size leave blank. Can also be set in the width parameter in the style
class.
vSize : ARRAY OF CHAR
Vertical size to fit the graphic in. To use the default or actual
size leave blank. Can also be set in the height parameter in the style
class.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE CloseReport
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
CloseReport - Close the current HTML file.
This procedure will close off the current HTML file. Now further
writing will be allowed. If the file is reopened then the current
data is lost.
CALLING SEQUENCE -
CloseReport (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginUnorderedList
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginUnorderedList - Begin an unordered list to the HTML file.
This procedure allows the user to write an unordered to the HTML file.
Each list item must be identifed with a BeginListItem.
At the conclution of the list an EndUnorderedList must be called.
CALLING SEQUENCE -
BeginUnorderedList (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the list class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndUnorderedList
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndUnorderedList - End an unordered list to the HTML file.
This procedure allows the user to write an end to an unordered list to the HTML file.
This is required for all BeginUnorderedList calls and results in an HTML error if not
specified.
CALLING SEQUENCE -
EndUnorderedList (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginOrderedList
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginOrderedList - Begin an ordered list to the HTML file.
This procedure allows the user to write an ordered list to the HTML file.
Each list item must be identifed with a BeginListItem.
At the conclution of the list an EndOrderedList must be called.
CALLING SEQUENCE -
BeginOrderedList (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the list class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndOrderedList
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndOrderedList - End an ordered list to the HTML file.
This procedure allows the user to write an end to an ordered list to the HTML file.
This is required for all BeginOrderedList calls and results in an HTML error if not
specified.
CALLING SEQUENCE -
EndOrderedList (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginListItem
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
BeginListItem - Start a list item to the HTML file.
This procedure allows the user to write a list item to the HTML file.
CALLING SEQUENCE -
BeginListItem (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginDefinitionList
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginDefinitionList - Begin an definition list to the HTML file.
This procedure allows the user to write a definition list to the HTML file.
Each list item must be identifed with a BeginDefinitionElement and
a BeginDefinition call. There can be mulitiple elements each definition and
also multiple definitions for elements.
At the conclution of the list an EndDefinitionList must be called.
CALLING SEQUENCE -
BeginDefinitionList (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the list class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndDefinitionList
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndDefinitionList - End an definition list to the HTML file.
This procedure allows the user to write an end to a definition list to the HTML file.
This is required for all BeginDefinitionList calls and results in an HTML error if not
specified.
CALLING SEQUENCE -
EndOrderedList (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginDefinitionElement
(VAR ReportHandle : HtmlHandleType;
CONST Element : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginDefinitionElement - Start a new element in list to the HTML file.
This procedure allows the user to write a new element to the list in the HTML file.
CALLING SEQUENCE -
BeginDefinitionElement (ReportHandle, Element, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
Element : ARRAY OF CHAR
The definition element name.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginDefinition
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
BeginDefinition - Start a new definition for an element in list to the HTML file.
This procedure allows the user to write a new definition to the list in the HTML file.
CALLING SEQUENCE -
BeginDefinitionElement (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE DrawHorizontalRule
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
DrawHorizontalRule - Draw a horizontal line to HTML file.
This procedure allows the user to write a horizontal line to the HTML file.
CALLING SEQUENCE -
DrawHorizontalRuleList (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginTable
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST width : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginTable - Begin a table.
This procedure sets up to write a table. When the table is finished
the user must call EndTable.
CALLING SEQUENCE -
BeginTable (ReportHandle, ClassName, Width, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
Width : ARRAY OF CHAR
The width of the table either absolute or percent (ie 500pt or 80%).
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginTableCaption
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginTableCaption - Begin a table header.
This procedure sets up to write a table Caption. It must also be followed by
a call to EndTableCaption.
CALLING SEQUENCE -
BeginTableCaption (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndTableCaption
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndTableCaption - End a table caption.
This procedure sets up to write a end of table caption.
CALLING SEQUENCE -
EndTableCaption (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginTableHeader
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginTableHeader - Begin a table header.
This procedure sets up to write a table header. This must be followed by
calls to BeginTableRow to define the header. It must also be followed by
a call to EndTableHeader.
CALLING SEQUENCE -
BeginTableHeader (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginTableFooter
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginTableFooter - Begin a table footer.
This procedure sets up to write a table footer. This must be followed by
calls to BeginTableRow to define the footer. It must also be followed by
a call to EndTableFooter.
CALLING SEQUENCE -
BeginTableFooter (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndTableHeader
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndTableHeader - End a table header.
This procedure sets up to write a end of table header.
CALLING SEQUENCE -
EndTableHeader (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndTableFooter
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndTableFooter - End a table footer.
This procedure sets up to write a end of table footer.
CALLING SEQUENCE -
EndTableFooter (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginTableColumnGroup
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Span : CARDINAL;
CONST width : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginTableColumnGroup - Begin a table COLGROUP.
This procedure sets up to write a table COLGROUP. This can be followed by
calls to SetTableColumn to define individual columns in the group. If one or more
columns are defined the the span value is ignored. It must also be followed by
a call to EndTableColumnGroup.
CALLING SEQUENCE -
BeginTableColumnGroup (ReportHandle, ClassName, Span, Width, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
Span : CARDINAL
Number of columns spanned by group
Width : ARRAY OF CHAR
Column widths either absolute, percentage or "0*" for minimum for column
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndTableColumnGroup
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndTableColumnGroup - End a table COLGROUP.
This procedure sets up to write a end of table COLGROUP.
CALLING SEQUENCE -
EndTableColumnGroup (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE SetTableColumn
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Span : CARDINAL;
CONST width : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
SetTableColumn - Start a table COL.
This procedure sets up to write a table COL.
CALLING SEQUENCE -
SetTableColumn (ReportHandle, ClassName, Span, Width, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
Span : CARDINAL
Number of columns spanned by group
Width : ARRAY OF CHAR
Column widths either absolute, percentage or "0*" for minimum for column
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginTableRow
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginTableRow - Begins a new table row.
This procedure starts a new row. Following this call you should call the WriteCell
routine for 1 to the number of columns currently defined for the table.
CALLING SEQUENCE -
BeginTableRow (ReportHandle, Classs, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndTableRow
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndTable - Ends the current table row.
This procedure ends the current table row. This is optional
CALLING SEQUENCE -
EndTableRow (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginTableCell
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST Colspan : CARDINAL;
CONST Rowspan : CARDINAL;
VAR Error : HtmlErrorType);
(**
BeginTableCell - Begin new cell data. Must be called in order left to right.
This procedure start new cell data. The cells are written from left to right.
A call to BeginTableRow is made. Then this procedure is called 1 .. NumColumns
times. After that a call to BeginTableRow is called to start new row or EndTable
is called.
CALLING SEQUENCE -
BeginTableCell (ReportHandle, ClassName, Colspan, Rowspan, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
Colspan : CARDINAL
The number of columns spanned by this cell.
Rowspan : CARDINAL
The number of rows spanned by this cell.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndTableCell
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndTableCell - Ends the current table cell.
This procedure ends the current table cell. Optional
CALLING SEQUENCE -
EndTableCell (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndTable
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndTable - Ends the current table.
This procedure ends the current table.
CALLING SEQUENCE -
EndTable (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginBold
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginBold - Write a bold tag.
This procedure sets up to begin bold writing. This can also be
done through a class style.
ALLING SEQUENCE -
BeginBold (ReportHandle, ClassName, Error);
NTRY -
ReportHandle : RftHandletype
A h andle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
XIT -
Error : HtmlErrorType
V a r iable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndBold
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndBold - Write a end bold tag.
This procedure sets up to end bold writing.
CALLING SEQUENCE -
EndBold (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginItalic
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginItalic - Write a italic tag.
This procedure sets up to begin italic writing. This can also be
done through a class style.
CALLING SEQUENCE -
BeginItalic (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndItalic
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndItalic - Write a end italic tag.
This procedure sets up to end italic writing.
CALLING SEQUENCE -
EndItalic (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginCenter
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginCenter - Write a center tag.
This procedure sets up to begin centered writing. This can also be
done through a class style.
CALLING SEQUENCE -
BeginCenter (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndCenter
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndCenter - Write a end center tag.
This procedure sets up to end centered writing.
CALLING SEQUENCE -
EndCenter (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginPreformatted
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginPreformatted - Write a PRE tag.
This procedure sets up to begin preformatted writing. Using this command
the browser generally preserves the white space and uses a fixed font to
preserve alignment.
CALLING SEQUENCE -
BeginPreformatted (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndPreformatted
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndPreformatted - Write a end PRE tag.
This procedure sets up to end preformatted writing.
CALLING SEQUENCE -
EndPreformatted (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginDivision
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginDivision - Start a new division.
This procedure sets up to begin a new division. A division starts a new
line. It is used to change the class style for what follows.
CALLING SEQUENCE -
BeginDivision (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndDivision
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndDivision - Write a end division tag.
This procedure sets up to end division set style.
CALLING SEQUENCE -
EndCenter (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginSpan
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
VAR Error : HtmlErrorType);
(**
BeginSpan - Begin a new spanning style.
This procedure sets up to begin a new span. A span does not starts a new
line. It is used to change the class style for what follows.
CALLING SEQUENCE -
BeginSpan (ReportHandle, ClassName, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndSpan
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndSpan - Write a end span tag.
This procedure sets up to end span set style.
CALLING SEQUENCE -
EndCenter (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE BeginHeading
(VAR ReportHandle : HtmlHandleType;
CONST ClassName : ARRAY OF CHAR;
CONST HeaderNum : CARDINAL;
VAR Error : HtmlErrorType);
(**
BeginHeading - Write a header tag.
This procedure sets up to begin heading writing. This can also be
done through a class style.
CALLING SEQUENCE -
BeginHeading (ReportHandle, ClassName, HeaderNum, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
ClassName : ARRAY OF CHAR
Specify the class of the style sheet. Leave blank to use default.
HeaderNum : CARDINAL
Heading number (1-6). Do not nest headings
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE EndHeading
(VAR ReportHandle : HtmlHandleType;
VAR Error : HtmlErrorType);
(**
EndHeading - Write a end heading tag.
This procedure sets up to end heading writing. Do not nest headers.
CALLING SEQUENCE -
EndHeading (ReportHandle, Error);
ENTRY -
ReportHandle : RftHandletype
A handle to the HTML file.
EXIT -
Error : HtmlErrorType
Variable to indicate whether the operation was successful or
encountered a problem.
*)
PROCEDURE GetHandleState
(CONST ReportHandle : HtmlHandleType) : ModSys.HandleState;
(**
GetHandleState - Gets the current state of the handle (HandleOpened or HandleClosed).
This procedure gets the state of the handle. It returns one of two values depending
on whether the handle is currently open or closed.
CALLING SEQUENCE -
GetHandleState (ReportHandle);
ENTRY -
ReportHandle : HtmlHandleType
The file handle to be tested.
EXIT -
HandleState
ModSys.HandleClosed - The handle is currently closed.
ModSys.HandleOpen - The handle is open for use.
*)
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance