setFooter

Adds a footer to a spreadsheet which will display when printed. Text can be provided for the left, centre and right of the footer.

setFooter( workbook [, leftFooter [, centerFooter [, rightFooter ] ] ] )

Required arguments

• workbook spreadsheet object

Optional arguments

• leftFooter string: text to place on the left hand side of the footer
• centerFooter string: text to place in the centre of the footer
• rightFooter string: text to place on the right of the footer

Chainable? Yes.

Note

Footers can include formatting codes allowing styles and dynamic values such as page numbers to be used in footers.

Example 1

spreadsheet = New spreadsheet();
workbook = spreadsheet.new();
spreadsheet.setFooter( workbook=workbook, centerFooter="ACME Ltd" );

Example 2

spreadsheet.setFooter( workbook=workbook, rightFooter="Page &P of &N" ); // Page 1 of 1 will be printed in the right hand header