Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
XL.Sheet.SetFooter
Sets the footer text for the sheet when printed.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
XL | 3.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.SetFooter"; bookRef; sheetIndex; Text { ; Margin } ) More
Parameters
Parameter | Description | Example | Flags |
---|---|---|---|
bookRef | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref | |
sheetIndex | The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. | 0 | |
Text | The new footer text. | "test" | |
Margin | The margin to use. | 0.5 | Optional |
Result
Returns OK or error message.
Description
Sets the footer text for the sheet when printed.The footer text appears at the bottom of every page when printed. The length of the text must be less than or equal to 255. The footer text can contain special commands, for example a placeholder for the page number, current date or text formatting attributes. See XL.SetHeader for details. Margin is specified in inches.
See also XL.Sheet.SetPrintRepeatRows to create repeating rows on each printed page.
See also
- XL.Book.SheetCount
- XL.LoadBook
- XL.Sheet.SetHCenter
- XL.Sheet.SetHeader
- XL.Sheet.SetMerge
- XL.Sheet.SetPaper
- XL.Sheet.SetPrintRepeatRows
- XL.Sheet.SetRowPx
- XL.Sheet.SetVCenter
- XL.Sheet.SetZoom
This function checks for a license.
Created 18th August 2014, last changed 15th February 2022
XL.Sheet.SetDisplayGridlines - XL.Sheet.SetGroupSummaryBelow