Navigation: Ultimate Suite for PowerBuilder Help > PowerDock > Functions >

of_setbackgroundimage

Send comments on this topic.

 

Description:

Displays an image in the PowerDock control behind the document tabs. This area is visible when all PowerDock tabs are closed.

Syntax:

of_setbackgroundimage (string as_image, long al_position)

Argument

Description

as_image 

The file name of the image.

al_position 

A numeric value representing the position to display the image: TILED, STRETCHED, TOPLEFT, TOPCENTER, TOPRIGHT, MIDDLELEFT, MIDDLECENTER, MIDDLERIGHT, BOTTOMLEFT, BOTTOMCENTER, BOTTOMRIGHT.

TILED, STRETCHED, TOPLEFT, TOPCENTER, TOPRIGHT, MIDDLELEFT, MIDDLECENTER, MIDDLERIGHT, BOTTOMLEFT, BOTTOMCENTER, BOTTOMRIGHT are constants declared in the PowerDock control.

TILED - Display the image as a mosaic. The number of repeatitive images depends on the size of the image and the size of the control.
STRETCHED - Stretches the image to the full width and height of the control.
TOPLEFT - Displays the image in it's original size at the upper left corner of the control.
TOPCENTER - Displays the image in it's original size at the top centered position of the control.
TOPRIGHT - Displays the image in it's original size at the upper right corner of the control.
MIDDLELEFT - Displays the image in it's original size on the left side of the control, vertically centered.
MIDDLECENTER - Displays the image in it's original size in the center of the control, vertically centered.
MIDDLERIGHT - Displays the image in it's original size on the right side of the control, vertically centered.
BOTTOMLEFT - Displays the image in it's original size at the lower left corner of the control.
BOTTOMCENTER - Displays the image in it's original size at the bottom centered position of the control.
BOTTOMRIGHT - Displays the image in it's original size at the lower left corner of the control.

Return Value:

Returns 1.

Usage:


Copyright © 2021 Werysoft Inc.