BBjFormParagraph

Description

In BBj 4.0 and higher, the BBjFormParagraph object allows users to construct a block of text on a page.

Creation

BBjAPI > BBjPrinterBBjFormBBjFormPage > BBjFormParagraph

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

Return Value

Method

BBjFormParagraph

newParagraph()

 

Methods of BBjFormParagraph

Return Value

Method

BBjColor

getBackgroundColor()

font

getFont()

int

getHorizontalAlignment()

point

getNextParagraphPosition()

double

getNextParagraphX()

double

getNextParagraphY()

color

getTextColor()

int

getTextHeight()

int

isAutoAdjustHeight()

void

setAutoAdjustHeight(int adjust)

void

setBackgroundColor(BBjColor color)

void

setFont(Font font)

void

setHorizontalAlignment(int alignment)

void

setText(attributedString text)

void

setText(string text)

void

setTextColor(Color color)

 

Methods of BBjFormParagraph inherited from BBjFormElement

Return Value Method
void add(BBjFormElement object)
double getBottomMargin()
point getDrawingOrigin()
dimension getDrawingSize()
double getDrawingHeight()
double getDrawingWidth()
double getDrawingX()
double getDrawingY()
double getHeight()
int getHorizontalSticky()
double getLeftMargin()
BBjFormPage getPage()
BBjFormElement getParent()
point getPosition()
double getRightMargin()
dimension getSize()
double getTopMargin()
int getVerticalSticky()
double getWidth()
double getX()
double getY()
int isChild()
int isHorizontalFill()
int isVerticalFill()
void remove(BBjFormElement object)
void setBottomMargin(double margin)
void setHeight(double height)
void setHorizontalFill(int fill)
void setHorizontalSticky(int sticky)
void setLeftMargin(double margin)
void setPosition(double x, double y)
void setPosition(Point point)
void setRelative(int relative)
void setRightMargin(double margin)
void setSize(double width, double height)
void setSize(dimension size)
void setTopMargin(double margin)
void setVerticalFill(int fill)
void setVerticalSticky(int sticky)
void setWidth(double width)

Remarks

None.

Constants

LEFT_JUSTIFIED

RIGHT_JUSTIFIED

CENTER_JUSTIFIED

FULL_JUSTIFIED

Example

rem 'Get a new paragraph

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 myBBjForm! = myBBjPrinter!.getForm(1)

rem 'Get a new page
let myBBjFormPage! = myBBjForm!.createPage()

rem 'Get a new paragraph
let para! = myBBjFormPage!.newParagraph()
release

See Also

BBjAPI

BBj Object Variables

BBj Object Assignment

BBj Object Error Handling

BBj Object Operators

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.