Platforms to show: All Mac Windows Linux Cross-Platform

CPMPrintSessionMBS.BeginDocument(settings as CPMPrintSettingsMBS, pageformat as CPMPageFormatMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Begins a new document with the given settings.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.BeginDocumentNoDialog(settings as CPMPrintSettingsMBS, pageformat as CPMPageFormatMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Begins a new document with the given settings.
Notes:
Doesn't use the print progress dialog.
Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.BeginPage(pageformat as CPMPageFormatMBS, rect as CPMRectMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Begins a new page.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.BeginPageNoDialog(pageformat as CPMPageFormatMBS, rect as CPMRectMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Begins a new page.
Notes:
Doesn't use the print progress dialog.
Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.3 Yes No No No No
Function: Creates a new print session object.

Feedback, Comments & Corrections

CPMPrintSessionMBS.CreatePrinterList(list() as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.3 Yes No No No No
Function: Creates a list of all printers.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS

dim list() as string
session.CreatePrinterList(list)

MsgBox join(list, EndOfLine)
Notes:
List is an array of strings with the names of the printers.
Lasterror is set.

See also:

Feedback, Comments & Corrections

CPMPrintSessionMBS.CreatePrinterList(list() as string, byref index as Integer, byref currentprinter as CPMPrinterMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.1 Yes No No No No
Function: Creates a list of all printers.
Example:
dim session as CPMPrintSessionMBS = NewCPMPrintSessionMBS

dim list() as string
dim currentprinter as CPMPrinterMBS
dim index as Integer
session.CreatePrinterList(list, index, currentprinter)

MsgBox join(list, EndOfLine)
Notes:
List is an array of strings with the names of the printers.
Index is the index of the current printer inside this list.
CurrentPrinter is the current printer selected.
Lasterror is set.

See also:

Feedback, Comments & Corrections

CPMPrintSessionMBS.CurrentPrinter as CPMPrinterMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: The current printer for this session.
Notes:
Lasterror is set.
Setting this can only be done on Mac OS X.
(Read and Write computed property)

Feedback, Comments & Corrections

CPMPrintSessionMBS.CurrentPrinterName as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Printing MBS MacCG Plugin 12.1 Yes No No No No
Function: The current printer for this session by name.
Notes:
Lasterror is set.
(Read and Write computed property)

Feedback, Comments & Corrections

CPMPrintSessionMBS.DefaultPageFormat(pageformat as CPMPageFormatMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Sets the page format object to the default settings.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.DefaultPrintSettings(printsettings as CPMPrintSettingsMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Sets the settings object to the default settings.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.EndDocument
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Ends the current document.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.EndDocumentNoDialog
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Ends the current document.
Notes:
Doesn't use the print progress dialog.
Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.EndPage
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Ends the current page.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.EndPageNoDialog
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Ends the current page.
Notes:
Doesn't use the print progress dialog.
Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.GetDestinationFormat(printsettings as CPMPrintSettingsMBS) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.1 Yes No No No No
Function: Returns the destination format value.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.GetDestinationLocation(printsettings as CPMPrintSettingsMBS) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.1 Yes No No No No
Function: Returns the destination location value.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.GetDestinationType(printsettings as CPMPrintSettingsMBS) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Returns the destination type value.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.PageContext as CGContextMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Creates a new CGContext object for the current page.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.PageSetupDialog(pageformat as CPMPageFormatMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Shows the page setup dialog.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.PrintDialog(settings as CPMPrintSettingsMBS, pageformat as CPMPageFormatMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Shows the print dialog.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.SetDestination(printsettings as CPMPrintSettingsMBS, desttype as Integer, destformat as String, desturl as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 12.1 Yes No No No No
Function: Sets a new destination.
Notes:
Some destinations so you may need to specify a format, else you can pass "" for the default format. Some destinations require a URL to a file.

Destination type codes:
kPMDestinationInvalid0
kPMDestinationPrinter1
kPMDestinationFile2
kPMDestinationFax3
kPMDestinationPreview4

Destformat strings:
kPMDocumentFormatPDFapplication/pdf
kPMDocumentFormatPICTapplication/vnd.apple.printing-pict
kPMDocumentFormatPICTPSapplication/vnd.apple.printing-pict-ps
kPMDocumentFormatPostScriptapplication/postscript

Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.UseSheets(docWindow as window)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 9.3 Yes No No No No
Function: Specifies that a printing dialog should be displayed as a sheet.
Notes:
docWindow: The window to which the sheet dialog should be attached.
Lasterror is set. (-1 for the docWindow parameter being nil)

Feedback, Comments & Corrections

CPMPrintSessionMBS.ValidatePageFormat(pageformat as CPMPageFormatMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Validates the page format.
Notes: Lasterror is set.

Feedback, Comments & Corrections

CPMPrintSessionMBS.ValidatePrintSettings(printsettings as CPMPrintSettingsMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Printing MBS MacCG Plugin 2.7 Yes No No No No
Function: Validates the print settings.
Notes: Lasterror is set.

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS MacCG Plugin.

The biggest plugin in space...




Links
MBS Xojo Plugins