BBjFormParagraph::getBackgroundColor

Description

In BBj 4.0 and higher, this method obtains the default background color for the field.

Syntax

Return Value

Method

BBjColor

getBackgroundColor()

Parameters

None.

Return Value

Returns the default background color for the field.

Remarks

None.

Example

rem 'Get paragraph text color

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()

rem 'Get paragraph text color
let color! = para!.getBackgroundColor()
release

See Also

BBjAPI

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