LibreOffice
LibreOffice 24.2 SDK API Reference
Public Attributes | List of all members
PrintOptions Service Referencepublished

describes the options for print jobs. More...

import"PrintOptions.idl";

Public Attributes

short CopyCount
 specifies the number of copies to print. More...
 
string FileName
 if set, specifies the name of a file to print to. More...
 
boolean Collate
 advises the printer to collate the pages of the copies. More...
 
boolean Sort
 advises the printer to sort the pages of the copies. More...
 
string Pages
 specifies which pages to print. More...
 
boolean Wait
 if set to TRUE, the corresponding XPrintable.print() request will be executed synchronous. More...
 
short DuplexMode
 determines the duplex mode for the print job. More...
 
string PrinterName
 if set, specifies name of the printer to use. More...
 
boolean SinglePrintJobs
 advises the printer to create a single print job for each copy. More...
 
boolean JobName
 The job name which is sent to the printer (can be seen in the Printer job queue). More...
 

Detailed Description

describes the options for print jobs.

These options are only valid for a single print job. They do not change layout or formatting of the document.

Developers Guide
Drawings and Presentations - Printing Drawing Documents - Printer and Print Job Settings
Spreadsheet Documents - Printing Spreadsheet Documents - Printer and Print Job Settings

Member Data Documentation

◆ Collate

boolean Collate
property

advises the printer to collate the pages of the copies.

◆ CopyCount

short CopyCount
property

specifies the number of copies to print.

◆ DuplexMode

short DuplexMode
optionalproperty

determines the duplex mode for the print job.

See also
DuplexMode for more information about supported values

◆ FileName

string FileName
property

if set, specifies the name of a file to print to.

◆ JobName

boolean JobName
optionalproperty

The job name which is sent to the printer (can be seen in the Printer job queue).

If omitted, the document title will be used as default.

Since
LibreOffice 7.5

◆ Pages

string Pages
property

specifies which pages to print.

This range is given as at the user interface. For example: "1-4;10" to print the pages 1 to 4 and 10.

◆ PrinterName

string PrinterName
optionalproperty

if set, specifies name of the printer to use.

◆ SinglePrintJobs

boolean SinglePrintJobs
optionalproperty

advises the printer to create a single print job for each copy.

◆ Sort

boolean Sort
property

advises the printer to sort the pages of the copies.

Deprecated:
Use Collate instead.

◆ Wait

boolean Wait
optionalproperty

if set to TRUE, the corresponding XPrintable.print() request will be executed synchronous.

Default is the asynchronous print mode.

Attention
Using of this property with TRUE as value is highly recommended. Otherwise following actions (as e.g. closing the corresponding model) can fail.

The documentation for this service was generated from the following file: