Monkeybread Xojo plugin - NSPrintInfoMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

NSPrintInfoMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	Cocoa Printing	MBS MacCocoa Plugin	12.4	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

An NSPrintInfo object stores information that's used to generate printed output.

Example

// get Xojo printer setup
Var p as new PrinterSetup

// now put it into NSPrintInfo to manipulate
Var n as new NSPrintInfoMBS
n.SetupString = p.SetupString

// change destination to file
Var f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
n.SetSaveDestination(f)

// move back
p.SetupString = n.SetupString

// and print as usual
Var g as Graphics = OpenPrinter(p)
g.DrawString "Hello World", 20, 20

A shared NSPrintInfo object is automatically created for an application and is used by default for all printing jobs for that application.

The printing information in an NSPrintInfo object is stored in a dictionary. To access the standard attributes in the dictionary directly, this class defines a set of keys and provides the dictionary method. You can also initialize an instance of this class using the Constructor method.

You can use this dictionary to store custom information associated with a print job. Any non-object values should be stored as NSNumber or NSValue objects in the dictionary. See NSNumber Class Reference for a list of types which should be stored as numbers. For other non-object values, use the NSValue class.

Beginning with OS X v10.5, to store custom information that belongs in printing presets you should use the dictionary returned by the printSettings method.

24 properties
- property bottomMargin as Double
- property data as Memoryblock
- property dictionary as dictionary
- property Duplex as Integer
- property Handle as Integer
- property HorizontallyCentered as boolean
- property horizontalPagination as Integer
- property imageablePageBounds as NSRectMBS
- property jobDisposition as string
- property leftMargin as Double
- property localizedPaperName as string
- property orientation as Integer
- property paperName as string
- property paperSize as NSSizeMBS
- property printer as NSPrinterMBS
- property printerName as String
- property printSettings as dictionary
- property rightMargin as Double
- property scalingFactor as Double
- property SelectionOnly as boolean
- property SetupString as Memoryblock
- property topMargin as Double
- property VerticallyCentered as boolean
- property verticalPagination as Integer
6 methods
- method Constructor
- method Constructor(attributes as Dictionary)
- method Constructor(Data as Memoryblock)
- method copy as NSPrintInfoMBS
- method SetSaveDestination(file as folderitem)
- method setUpPrintOperationDefaultValues
37 shared methods
- shared method defaultPrinter as NSPrinterMBS
- shared method NSPrintAllPages as string
- shared method NSPrintBottomMargin as string
- shared method NSPrintCancelJob as string
- shared method NSPrintCopies as string
- shared method NSPrintDetailedErrorReporting as string
- shared method NSPrintFaxNumber as string
- shared method NSPrintFirstPage as string
- shared method NSPrintHeaderAndFooter as string
- shared method NSPrintHorizontallyCentered as string
- shared method NSPrintHorizontalPagination as string
- shared method NSPrintJobDisposition as string
- shared method NSPrintJobSavingFileNameExtensionHidden as string
- shared method NSPrintJobSavingURL as string
- shared method NSPrintLastPage as string
- shared method NSPrintLeftMargin as string
- shared method NSPrintMustCollate as string
- shared method NSPrintOrientation as string
- shared method NSPrintPagesAcross as string
- shared method NSPrintPagesDown as string
- shared method NSPrintPaperName as string
- shared method NSPrintPaperSize as string
- shared method NSPrintPreviewJob as string
- shared method NSPrintPrinter as string
- shared method NSPrintPrinterName as string
- shared method NSPrintReversePageOrder as string
- shared method NSPrintRightMargin as string
- shared method NSPrintSaveJob as string
- shared method NSPrintScalingFactor as string
- shared method NSPrintSelectionOnly as string
- shared method NSPrintSpoolJob as string
- shared method NSPrintTime as string
- shared method NSPrintTopMargin as string
- shared method NSPrintVerticallyCentered as string
- shared method NSPrintVerticalPagination as string
- shared method setSharedPrintInfo(printInfo as NSPrintInfoMBS)
- shared method sharedPrintInfo as NSPrintInfoMBS
9 constants

Pagination Modes

Constant	Value	Description
NSAutoPagination	0	The image is divided into equal-sized rectangles and placed in one column of pages.
NSClipPagination	2	The image is clipped to produce one column or row of pages.
NSFitPagination	1	The image is scaled to produce one column or one row of pages.

Page Orientation Constants

Constant	Value	Description
NSLandscapeOrientation	1	Orientation is portrait (page is taller than it is wide).
NSPortraitOrientation	0	Orientation is landscape (page is wider than it is tall).

Duplex Modes

Constant	Value	Description
PMDuplexNone	1	Print only on one side of sheet of paper
PMDuplexNoTumble	2	Print on both sides of the paper, with no tumbling.
PMDuplexTumble	3	Print on both sides of the paper, tumbling on.
PMSimplexTumble	4	Print on only one side of the paper, but tumble the images while printing.

This class has no sub classes.

Blog Entries

Release notes

Version 24.3
- Added Duplex property to NSPrintInfoMBS class.

Some methods using this class:

DesktopWKWebViewControlMBS.printOperation(printInfo as NSPrintInfoMBS) as NSPrintOperationMBS
NSPageLayoutMBS.beginSheetWithPrintInfo(printInfo as NSPrintInfoMBS, win as NSWindowMBS)
NSPageLayoutMBS.beginSheetWithPrintInfo(printInfo as NSPrintInfoMBS, win as window)
NSPageLayoutMBS.printInfo as NSPrintInfoMBS
NSPrintOperationMBS.EPSOperationWithView(view as NSViewMBS, rect as NSRectMBS, printInfo as NSPrintInfoMBS, path as string) as NSPrintOperationMBS
NSPrintOperationMBS.PDFOperationWithView(view as NSViewMBS, rect as NSRectMBS, printInfo as NSPrintInfoMBS, path as string) as NSPrintOperationMBS
NSPrintOperationMBS.printOperationWithView(view as HTMLViewer, printInfo as NSPrintInfoMBS = nil) as NSPrintOperationMBS
NSPrintPanelMBS.beginSheetWithPrintInfo(printInfo as NSPrintInfoMBS, win as DesktopWindow)
NSPrintPanelMBS.printInfo as NSPrintInfoMBS
NSPrintPanelMBS.runModalWithPrintInfo(printInfo as NSPrintInfoMBS) as Integer

Some properties using for this class:

NSPrintOperationMBS.printInfo as NSPrintInfoMBS

Some examples using this class:

Some related classes:

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

NSPrinterMBS - NSPrintOperationMBS

💬 Ask a question or report a problem