XL_SETFOOTER()

 

Version Ref: Version 6.1.00 (USP 6.0.03)

 

Syntax:

 

 e = XL_SETFOOTER(string [, margin, [limage, [cimage, [rimage, [sheet]]]]])
	Set the printed page footer.

	Parameters -
		string : The header/footer definition string. See below for format 
		         options. Cannot be blank.
		margin : The margin in inches to use for the header/footer. A blank,
				 "0", or negative value will use the default margin of "0.3".
		limage : Full path to an image to use in place of the left image 
		         placeholder.
		cimage : Full path to an image to use in place of the center image 
		         placeholder.
		rimage : Full path to an image to use in place of the right image 
		         placeholder.
		sheet  : Handle of sheet to set header/footer. Use blank, "0", or "-1"
				 to use the default sheet.
				
	Format Options -

Control Category Description
&L Justification Left
&C Center
&R Right
&P Information Page number
&N Total number of pages
&D Date
&T Time
&F File Name
&A Worksheet name
&Z Workbook path
&fontsize Font Font size
&"font,style" Font name and style
&U Single underline
&E Double underline
&S Strikethrough
&X Superscript
&Y Subscript
&[Picture] Image placeholder
&G Same as &[Picture]
&& Literal ampersand & 


	Text in headers and footers can be justified to the left, center and right 
	by prefixing the text with the control characters &L, &C and &R.
	For example, "&LHello, World!", "&CHello, World!", "&RHello, World!"
	
	For simple text, if the justification is not specified the text will be 
	center aligned. However, you must prefix the text with &C if you use any
	other formatting.
	
	You are limited to 3 images in a header/footer.
	
	Returns "1" on success and "-1" on error. XL_ERROR() can be called to return
	the last error.
	
	Note: The image types supported are PNG, JPEG, and BMP files. There is a
	hard limit of 255 characters in a header/footer string, including control
	characters. Strings longer than this will not be written to the document.