Developer's reference PB2XLS for PowerBuilder

Reference > N_XLS_FORMAT > of_set_bg_color

of_set_bg_color() method

Set the background color of a pattern. Patterns are defined via the of_set_pattern() method. If a pattern hasn't been defined then a solid fill pattern is used as the default.

Syntax

format.of_set_bg_color ( color )

Parameters

colorInteger from 8..63 (index of color. See of_set_custom_color() ) or the string whose value is the color (See valid colors)

Return value

Integer. Returns 1 if it succeeds and -1 if an error occurs.

Examples

format1.of_set_bg_color ( 16 )
format2.of_set_bg_color ( 'yellow' )