Developer's reference PB2XLS for PowerBuilder

Reference > N_XLS_WORKSHEET > of_set_footer

of_set_footer() method

Set the page footer.

Syntax

worksheet.of_set_footer ( footer, margin )

Parameters

footerA string or a blob (unicode string) whose value is the page footer
margina double whose value is the footer margin in inches

Return value

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

Description

The footer is a combination of plain text and control characters (See header and footer string).
Note, the header string must be less than 255 characters. Strings longer than this will not be written and a warning will be generated. The default footer margin is 0.50 inch.

Examples

worksheet.of_set_footer( 'Footer' , 0.75)    	 // set the page footer and footer margin