spreadsheetSetFitToPage

Sets the fit-to-page print option on the active sheet of a spreadsheet workbook. When state is true the sheet is scaled to fit across pagesWide columns and pagesHigh rows (each minimum 1); when false the fit-to-page setting is cleared. The fluent member form is setFitToPage(state, pagesWide, pagesHigh).

spreadsheetSetFitToPage(spreadsheetObj, state, pagesWide, pagesHigh) → returns any

This function requires RustCFML.  Not supported on Lucee, Adobe ColdFusion, etc.
  1. CFDocs
  2. Functions
  3. All CFML Functions
  4. spreadsheetSetFitToPage
  5. RustCFML
  6. 0 Issue
  7. Edit
See Also:   spreadsheetSetPrintOrientation   spreadsheetNew

Argument Reference

spreadsheetObj any
Required

The spreadsheet workbook object.

state boolean
Default: true

True to enable fit-to-page, false to clear it (default true).
Values:
  • true
  • false

pagesWide numeric
Default: 1

Number of pages wide to fit into (default 1, minimum 1 when enabled).

pagesHigh numeric
Default: 1

Number of pages high to fit into (default 1, minimum 1 when enabled).

Compatibility

RustCFML:

Not supported on wasm32.

Examples
Sample code invoking the spreadsheetSetFitToPage function

Scale the active sheet to one page wide by one page high.

wb = Spreadsheet("xlsx");
spreadsheetSetFitToPage(wb, true, 1, 1);

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub