BBjFormPage

Description

In BBj 4.0 and higher, the BBjFormPage object allows users to construct a page for a document.

Creation

BBjAPI > BBjPrinter > BBjForm > BBjFormPage

The BBjFormPage object is created through the following BBjForm object method:

Return Value	Method
BBjFormPage	createPage()
BBjFormPage	createPage(double conversion)

Methods of BBjFormPage

Return Value	Method
void	add(BBjFormElement `object`)
void	clear()
double	getBottomMargin()
byte[]	getBytesForFile(String `file`)
double	getLeftMargin()
double	getPrintableAreaHeight()
point	getPrintableAreaOrigin()
double	getPrintableAreaWidth()
double	getPrintableAreaX()
double	getPrintableAreaY()
double	getRightMargin()
double	getTextWidth(String `text`, Font `font`) getTextWidth(AttributedString `text`)
double	getTopMargin()
BBjFormFittedField	newFittedField()
BBjFormFittedField	newFittedField(double `x`, double `y`, double `width`, double `height`)
BBjFormFrame	newFrame()
BBjFormFrame	newFrame(double x, double y, double width, double height)
BBjFormImage	newImage()
BBjFormImage	newImage(string URL, double x, double y, double width, double height)
BBjFormLine	newLine()
BBjFormLine	newLine(double x, double y, double width, double height)
BBjFormParagraph	newParagraph()
BBjFormParagraph	newParagraph(double x, double y, double width, double height)
void	setBottomMargin(double margin)
void	setLeftMargin(double margin)
void	setRightMargin(double margin)
void	setTopMargin(double margin)

Remarks

All page coordinates are specified in points or units specified at page creation. A point is approximately 1/72 inch or 1/3 millimeter.

Constants

None.

Example

rem 'Create a new page

rem 'Obtain the instance to the BBjAPI object
myAPI! = BBjAPI()

rem 'Obtain an instance of a default BBjPrinter object
let myBBjPrinter! = myAPI!.getBBjPrinter(0)

rem 'Get BBjForm for the selected printer
let myForm! = myBBjPrinter!.getForm(1)

rem 'Get a new page
let myPage1! = myForm!.createPage()

rem 'Get a new page using MM units.
let myPage2! = myForm!.createPage(myForm!.MM_UNITS)
release