BBjFormElement::getHorizontalSticky

Description

In BBj 4.0 and higher, this method gets the horizontal sticky option of the form element.

Syntax

Return Value

Method

int

getHorizontalSticky()

Parameters

None.

Return Value

Returns the horizontal sticky option of the form element.

Remarks

None.

Example

rem 'Get horizontal sticky

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 horizontal sticky
let sticky = para!.getHorizontalSticky()
release

See Also

BBjAPI

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