Developer's reference PB2XLS for PowerBuilder

Reference > N_XLS_WORKSHEET > of_set_header

of_set_header() method

Set the page header.

Syntax

worksheet.of_set_header ( header, margin )

Parameters

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

Return value

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

Description

The header 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 header margin is 0.50 inch.

Examples

worksheet.of_set_header( 'Header' , 0.75)    	 // set the page header and header margin