Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

WebView.SetPrintParameter

Sets print parameters for WebView.Print method.

Component Version macOS Windows Linux Server iOS SDK
WebView 2.1 ✅ Yes ✅ Yes ❌ No ❌ No ✅ Yes
MBS( "WebView.SetPrintParameter"; ParameterName; ParameterValue )   More

Parameters

Parameter Description Example
ParameterName The name of the parameter.
For MacOS, can be horizontallyCentered, verticallyCentered, showPrintPanel, orientation, printer, bottomMargin, topMargin, leftMargin or rightMargin.		 orientation
ParameterValue The value for the given parameter: A boolean value for horizontallyCentered, verticallyCentered and showPrintPanel. "portrait" or "landscape" for orientation. The printer name for printer. A number for bottomMargin, topMargin, leftMargin or rightMargin. portrait

Result

Returns OK or an error message.

Description

Sets print parameters for WebView.Print method.
If showPrintPanel (Default 1) if set to 0, then no print window is shown. verticallyCentered and horizontallyCentered define if content is centered. If printer name is not valid, it will be ignored.

Parameters for iOS:
  • Duplex: None, LongEdge or ShortEdge,
  • OutputType: General, Photo, Grayscale or PhotoGrayscale,
  • JobName and
  • Orientation: Portrait or Landscape.
Parameters for Windows with Edge:
  • Orientation: Portrait or Landscape.
  • ShouldPrintBackgrounds,
  • PaperWidth,
  • PaperHeight,
  • BottomMargin,
  • TopMargin,
  • LeftMargin,
  • RightMargin,
  • ShouldPrintHeaderAndFooter: 1 or 0,
  • ShouldPrintSelectionOnly: 1 or 0,
  • HeaderTitle and
  • FooterUri
  • PageRanges
  • PrinterName
  • PagesPerSide
  • Copies
  • Collation
  • ColorMode
  • Duplex
Parameters for macOS with WebKit 2:
  • HorizontallyCentered,
  • VerticallyCentered,
  • ShowPrintPanel,
  • Orientation: Portrait or Landscape.
  • PaperName,
  • Printer,
  • PaperWidth,
  • PaperHeight,
  • BottomMargin,
  • TopMargin,
  • LeftMargin,
  • RightMargin,
  • ShouldPrintBackgrounds and
  • MinimumFontSize.
Orientation can be portrait or landscape.
Margins are in points (at 72 dpi).

For Windows:
HeaderTitle: The default value is the title of the current document. If an empty string or null value is provided, no title is shown in the header.
FooterURI: The default value is the current URI. If an empty string or null value is provided, no URI is shown in the footer.
Collation: 0 for default, 1 for collated and 2 for uncollated.
Duplex: 0 for default, 1 for one sided, 2 for two sided and long edge, 3 for two sided and short edge.
ColorMode: 0 for default, 1 for color and 2 for gray.

Use WebView.GetPrintParameter to query values.

Examples

Sets bottom margin to 5 points:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "bottomMargin"; 5) ]

Use square paper size:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "paperWidth"; 800)]
Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "paperHeight"; 800)]

Use A4 paper on macOS:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "paperName"; "iso-a4") ]

Set landscape:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "orientation"; "landscape") ]

Set portrait:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "orientation"; "portrait") ]

The paper size to match A4:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "paperWidth"; 576) ]
Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "paperHeight"; 842) ]

Ask to print backgrounds:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "ShouldPrintBackgrounds"; 1) ]

Ask to save ink by not print backgrounds:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "ShouldPrintBackgrounds"; 0) ]

Ask to print only selection:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "ShouldPrintSelectionOnly"; 1) ]

Ask to print header and footer:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "ShouldPrintHeaderAndFooter"; 1) ]

Custom header and footer on Windows:

Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "ShouldPrintHeaderAndFooter"; 1) ]
Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "HeaderTitle"; "Hello World") // default is website title ]
Set Variable [ $r ; Value: MBS("WebView.SetPrintParameter"; "FooterUri"; "https://www.mbsplugins.de") // default is website URI ]

See also

Release notes

Example Databases

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 11st May 2026


WebView.SetPreferences - WebView.SetPrivateBrowsing


MarkDown version: WebViewSetPrintParameter.md