Monkeybread Software - MBS FileMaker Plugin: DynaPDF.Print.SetSetting

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

DynaPDF.Print.SetSetting

Sets a print setting.

Component	Version	macOS	Windows	Linux	Server	iOS SDK
DynaPDF	11.4	❌ No	✅ Yes	❌ No	✅ Yes, on Windows	❌ No

MBS( "DynaPDF.Print.SetSetting"; Selector; Value ) More

Parameters

Parameter Description Example

Selector What propert to set.
This includes PrinterName, Orientation, PaperSize, PaperLength, PaperWidth, Scale, Copies, DefaultSource, PrintQuality, Color, Duplex, YResolution, TTOption, Collate, FormName, MediaType, and DitherType. "PrinterName"

Value The value to set.
Can be empty for most values to clear it.

Parameter	Description	Example
Selector	What propert to set. This includes PrinterName, Orientation, PaperSize, PaperLength, PaperWidth, Scale, Copies, DefaultSource, PrintQuality, Color, Duplex, YResolution, TTOption, Collate, FormName, MediaType, and DitherType.	"PrinterName"
Value	The value to set. Can be empty for most values to clear it.

Result

Returns OK or error.

Description

Sets a print setting.
Value can be empty (or -1) to clear value.

PrinterName: A text that specifies the "friendly" name of the printer or display; for example, "PCL/HP LaserJet" in the case of PCL/HP LaserJet. This string is unique among device drivers. Note that this name may be truncated to fit in the field. Can be overwritten via parameter to DynaPDF.Print!

Orientation: Value 1 is portrait and 2 is landscape.

PaperSize: Selects the size of the paper to print on. This member can be set to zero if the length and width of the paper are both set by the PaperLength and PaperWidth members. Otherwise, the PaperSize member can be set to a device specific value greater than or equal to DMPAPER_USER or to one of the following predefined values.

Value	Numeric	Meaning
DMPAPER_LETTER	1	Letter 8 1/2 x 11 in
DMPAPER_LETTERSMALL	2	Letter Small 8 1/2 x 11 in
DMPAPER_TABLOID	3	Tabloid 11 x 17 in
DMPAPER_LEDGER	4	Ledger 17 x 11 in
DMPAPER_LEGAL	5	Legal 8 1/2 x 14 in
DMPAPER_STATEMENT	6	Statement 5 1/2 x 8 1/2 in
DMPAPER_EXECUTIVE	7	Executive 7 1/4 x 10 1/2 in
DMPAPER_A3	8	A3 297 x 420 mm
DMPAPER_A4	9	A4 210 x 297 mm
DMPAPER_A4SMALL	10	A4 Small 210 x 297 mm
DMPAPER_A5	11	A5 148 x 210 mm
DMPAPER_B4	12	B4 (JIS) 250 x 354
DMPAPER_B5	13	B5 (JIS) 182 x 257 mm
DMPAPER_FOLIO	14	Folio 8 1/2 x 13 in
DMPAPER_QUARTO	15	Quarto 215 x 275 mm
DMPAPER_10X14	16	10x14 in
DMPAPER_11X17	17	11x17 in
DMPAPER_NOTE	18	Note 8 1/2 x 11 in
DMPAPER_ENV_9	19	Envelope #9 3 7/8 x 8 7/8
DMPAPER_ENV_10	20	Envelope #10 4 1/8 x 9 1/2
DMPAPER_ENV_11	21	Envelope #11 4 1/2 x 10 3/8
DMPAPER_ENV_12	22	Envelope #12 4 \276 x 11
DMPAPER_ENV_14	23	Envelope #14 5 x 11 1/2
DMPAPER_CSHEET	24	C size sheet
DMPAPER_DSHEET	25	D size sheet
DMPAPER_ESHEET	26	E size sheet
DMPAPER_ENV_DL	27	Envelope DL 110 x 220mm
DMPAPER_ENV_C5	28	Envelope C5 162 x 229 mm
DMPAPER_ENV_C3	29	Envelope C3 324 x 458 mm
DMPAPER_ENV_C4	30	Envelope C4 229 x 324 mm
DMPAPER_ENV_C6	31	Envelope C6 114 x 162 mm
DMPAPER_ENV_C65	32	Envelope C65 114 x 229 mm
DMPAPER_ENV_B4	33	Envelope B4 250 x 353 mm
DMPAPER_ENV_B5	34	Envelope B5 176 x 250 mm
DMPAPER_ENV_B6	35	Envelope B6 176 x 125 mm
DMPAPER_ENV_ITALY	36	Envelope 110 x 230 mm
DMPAPER_ENV_MONARCH	37	Envelope Monarch 3.875 x 7.5 in
DMPAPER_ENV_PERSONAL	38	6 3/4 Envelope 3 5/8 x 6 1/2 in
DMPAPER_FANFOLD_US	39	US Std Fanfold 14 7/8 x 11 in
DMPAPER_FANFOLD_STD_GERMAN	40	German Std Fanfold 8 1/2 x 12 in
DMPAPER_FANFOLD_LGL_GERMAN	41	German Legal Fanfold 8 1/2 x 13 in
DMPAPER_ISO_B4	42	B4 (ISO) 250 x 353 mm
DMPAPER_JAPANESE_POSTCARD	43	Japanese Postcard 100 x 148 mm
DMPAPER_9X11	44	9 x 11 in
DMPAPER_10X11	45	10 x 11 in
DMPAPER_15X11	46	15 x 11 in
DMPAPER_ENV_INVITE	47	Envelope Invite 220 x 220 mm
DMPAPER_RESERVED_48	48	RESERVED--DO NOT USE
DMPAPER_RESERVED_49	49	RESERVED--DO NOT USE
DMPAPER_LETTER_EXTRA	50	Letter Extra 9 \275 x 12 in
DMPAPER_LEGAL_EXTRA	51	Legal Extra 9 \275 x 15 in
DMPAPER_TABLOID_EXTRA	52	Tabloid Extra 11.69 x 18 in
DMPAPER_A4_EXTRA	53	A4 Extra 9.27 x 12.69 in
DMPAPER_LETTER_TRANSVERSE	54	Letter Transverse 8 \275 x 11 in
DMPAPER_A4_TRANSVERSE	55	A4 Transverse 210 x 297 mm
DMPAPER_LETTER_EXTRA_TRANSVERSE	56	Letter Extra Transverse 9\275 x 12 in
DMPAPER_A_PLUS	57	SuperA/SuperA/A4 227 x 356 mm
DMPAPER_B_PLUS	58	SuperB/SuperB/A3 305 x 487 mm
DMPAPER_LETTER_PLUS	59	Letter Plus 8.5 x 12.69 in
DMPAPER_A4_PLUS	60	A4 Plus 210 x 330 mm
DMPAPER_A5_TRANSVERSE	61	A5 Transverse 148 x 210 mm
DMPAPER_B5_TRANSVERSE	62	B5 (JIS) Transverse 182 x 257 mm
DMPAPER_A3_EXTRA	63	A3 Extra 322 x 445 mm
DMPAPER_A5_EXTRA	64	A5 Extra 174 x 235 mm
DMPAPER_B5_EXTRA	65	B5 (ISO) Extra 201 x 276 mm
DMPAPER_A2	66	A2 420 x 594 mm
DMPAPER_A3_TRANSVERSE	67	A3 Transverse 297 x 420 mm
DMPAPER_A3_EXTRA_TRANSVERSE	68	A3 Extra Transverse 322 x 445 mm
DMPAPER_DBL_JAPANESE_POSTCARD	69	Japanese Double Postcard 200 x 148 mm
DMPAPER_A6	70	A6 105 x 148 mm
DMPAPER_JENV_KAKU2	71	Japanese Envelope Kaku #2
DMPAPER_JENV_KAKU3	72	Japanese Envelope Kaku #3
DMPAPER_JENV_CHOU3	73	Japanese Envelope Chou #3
DMPAPER_JENV_CHOU4	74	Japanese Envelope Chou #4
DMPAPER_LETTER_ROTATED	75	Letter Rotated 11 x 8 1/2 11 in
DMPAPER_A3_ROTATED	76	A3 Rotated 420 x 297 mm
DMPAPER_A4_ROTATED	77	A4 Rotated 297 x 210 mm
DMPAPER_A5_ROTATED	78	A5 Rotated 210 x 148 mm
DMPAPER_B4_JIS_ROTATED	79	B4 (JIS) Rotated 364 x 257 mm
DMPAPER_B5_JIS_ROTATED	80	B5 (JIS) Rotated 257 x 182 mm
DMPAPER_JAPANESE_POSTCARD_ROTATED	81	Japanese Postcard Rotated 148 x 100 mm
DMPAPER_DBL_JAPANESE_POSTCARD_ROTATED	82	Double Japanese Postcard Rotated 148 x 200 mm
DMPAPER_A6_ROTATED	83	A6 Rotated 148 x 105 mm
DMPAPER_JENV_KAKU2_ROTATED	84	Japanese Envelope Kaku #2 Rotated
DMPAPER_JENV_KAKU3_ROTATED	85	Japanese Envelope Kaku #3 Rotated
DMPAPER_JENV_CHOU3_ROTATED	86	Japanese Envelope Chou #3 Rotated
DMPAPER_JENV_CHOU4_ROTATED	87	Japanese Envelope Chou #4 Rotated
DMPAPER_B6_JIS	88	B6 (JIS) 128 x 182 mm
DMPAPER_B6_JIS_ROTATED	89	B6 (JIS) Rotated 182 x 128 mm
DMPAPER_12X11	90	12 x 11 in
DMPAPER_JENV_YOU4	91	Japanese Envelope You #4
DMPAPER_JENV_YOU4_ROTATED	92	Japanese Envelope You #4 Rotated*/
DMPAPER_P16K	93	PRC 16K 146 x 215 mm
DMPAPER_P32K	94	PRC 32K 97 x 151 mm
DMPAPER_P32KBIG	95	PRC 32K(Big) 97 x 151 mm
DMPAPER_PENV_1	96	PRC Envelope #1 102 x 165 mm
DMPAPER_PENV_2	97	PRC Envelope #2 102 x 176 mm
DMPAPER_PENV_3	98	PRC Envelope #3 125 x 176 mm
DMPAPER_PENV_4	99	PRC Envelope #4 110 x 208 mm
DMPAPER_PENV_5	100	PRC Envelope #5 110 x 220 mm
DMPAPER_PENV_6	101	PRC Envelope #6 120 x 230 mm
DMPAPER_PENV_7	102	PRC Envelope #7 160 x 230 mm
DMPAPER_PENV_8	103	PRC Envelope #8 120 x 309 mm
DMPAPER_PENV_9	104	PRC Envelope #9 229 x 324 mm
DMPAPER_PENV_10	105	PRC Envelope #10 324 x 458 mm
DMPAPER_P16K_ROTATED	106	PRC 16K Rotated
DMPAPER_P32K_ROTATED	107	PRC 32K Rotated
DMPAPER_P32KBIG_ROTATED	108	PRC 32K(Big) Rotated
DMPAPER_PENV_1_ROTATED	109	PRC Envelope #1 Rotated 165 x 102 mm
DMPAPER_PENV_2_ROTATED	110	PRC Envelope #2 Rotated 176 x 102 mm
DMPAPER_PENV_3_ROTATED	111	PRC Envelope #3 Rotated 176 x 125 mm
DMPAPER_PENV_4_ROTATED	112	PRC Envelope #4 Rotated 208 x 110 mm
DMPAPER_PENV_5_ROTATED	113	PRC Envelope #5 Rotated 220 x 110 mm
DMPAPER_PENV_6_ROTATED	114	PRC Envelope #6 Rotated 230 x 120 mm
DMPAPER_PENV_7_ROTATED	115	PRC Envelope #7 Rotated 230 x 160 mm
DMPAPER_PENV_8_ROTATED	116	PRC Envelope #8 Rotated 309 x 120 mm
DMPAPER_PENV_9_ROTATED	117	PRC Envelope #9 Rotated 324 x 229 mm
DMPAPER_PENV_10_ROTATED	118	PRC Envelope #10 Rotated 458 x 324 mm
DMPAPER_USER	256	User defined size.

PaperLength: overrides the length of the paper specified by the PaperSize member, either for custom paper sizes or for devices such as dot-matrix printers that can print on a page of arbitrary length. These values, along with all other values that specify a physical length, are in tenths of a millimeter.

PaperWidth: overrides the width of the paper specified by the PaperSize member.

Scale: Specifies the factor by which the printed output is to be scaled. The apparent page size is scaled from the physical page size by the given factor. For example, a letter-sized page with a Scale value of 0.50 would contain as much data as a page of 17- by 22-inches because the output text and graphics would be half their original height and width.

Copies: Selects the number of copies printed if the device supports multiple-page copies.

DefaultSource: Specifies the paper source.

Name	Numeric	Description
DMBIN_UPPER	1	Select the upper paper bin. This value is also used for the paper source for printers that only have one paper bin.
DMBIN_LOWER	2	Select the lower bin.
DMBIN_MIDDLE	3	Select the middle paper bin.
DMBIN_MANUAL	4	Manually select the paper bin.
DMBIN_ENVELOPE	5	Select the auto envelope bin.
DMBIN_ENVMANUAL	6	Select the manual envelope bin.
DMBIN_AUTO	7	Auto-select the bin.
DMBIN_TRACTOR	8	Select the bin with the tractor paper.
DMBIN_SMALLFMT	9	Select the bin with the smaller paper format.
DMBIN_LARGEFMT	10	Select the bin with the larger paper format.
DMBIN_LARGECAPACITY	11	Select the bin with large capacity.
DMBIN_CASSETTE	14	Select the cassette bin.
DMBIN_FORMSOURCE	15	Select the bin with the required form.

PrintQuality: Specifies the printer resolution. The number of dots per inch (DPI) and is therefore device dependent.

Color: Switches between color and monochrome on color printers. The following are the possible values:

Value	Numeric	Meaning
DMCOLOR_COLOR	2	Black & White only
DMCOLOR_MONOCHROME	1	With Color

Duplex: Selects duplex or double-sided printing for printers capable of duplex printing. Following are the possible values.

Value	Numeric	Meaning
DMDUP_SIMPLEX	1	Normal (nonduplex) printing.
DMDUP_HORIZONTAL	3	Short-edge binding, that is, the long edge of the page is horizontal.
DMDUP_VERTICAL	2	Long-edge binding, that is, the long edge of the page is vertical.

YResolution: Specifies the y-resolution, in dots per inch, of the printer. If the printer initializes this member, the PrintQuality member specifies the x-resolution, in dots per inch, of the printer.

TTOption: Specifies how TrueType fonts should be printed. This member can be one of the following values.

Value	Numeric	Meaning
DMTT_BITMAP	1	Prints TrueType fonts as graphics. This is the default action for dot-matrix printers.
DMTT_DOWNLOAD	2	Downloads TrueType fonts as soft fonts. This is the default action for Hewlett-Packard printers that use Printer Control Language (PCL).
DMTT_DOWNLOAD_OUTLINE	4	Downloads TrueType fonts as outline soft fonts.
DMTT_SUBDEV	3	Substitutes device fonts for TrueType fonts. This is the default action for PostScript printers.

Collate: Specifies whether collation should be used when printing multiple copies. (This member is ignored unless the printer driver indicates support for collation by setting the Fields member to include collate.) This member can be one of the following values.

Value	Numeric	Meaning
DMCOLLATE_TRUE	1	Collate when printing multiple copies.
DMCOLLATE_FALSE	0	Do not collate when printing multiple copies.

FormName: A text that specifies the name of the form to use; for example, "Letter" or "Legal".

MediaType: Specifies the type of media being printed on. The member can be one of the following predefined values, or a driver-defined value greater than or equal to the value of DMMEDIA_USER.

Value	Numeric	Meaning
DMMEDIA_STANDARD	1	Plain paper.
DMMEDIA_TRANSPARENCY	2	Transparent film.
DMMEDIA_GLOSSY	3	Glossy paper.
DMMEDIA_USER 256	Device-specific media start here.

DitherType: Specifies how dithering is to be done. The member can be one of the following predefined values, or a driver-defined value greater than or equal to the value of DMDITHER_USER.

Value	Numeric	Meaning
DMDITHER_NONE	1	No dithering.
DMDITHER_COARSE	2	Dithering with a coarse brush.
DMDITHER_FINE	3	Dithering with a fine brush.
DMDITHER_LINEART	4	Line art dithering, a special dithering method that produces well defined borders between black, white, and gray scaling. It is not suitable for images that include continuous graduations in intensity and hue, such as scanned photographs.
DMDITHER_GRAYSCALE	10	Device does gray scaling.
DMDITHER_USER	256	Device-specific dithers start here.

You can query values with DynaPDF.Print.GetSetting function.

See also Print function in DynaPDF manual.

Examples

Sets paper size to DIN A4:

MBS( "DynaPDF.Print.SetSetting"; "PaperSize"; 9 // A4 210 x 297 mm )

Sets paper size to US Letter:

MBS( "DynaPDF.Print.SetSetting"; "PaperSize"; 1 // US Letter 8 1/2 x 11 in )

Set printer paper size and orientation:

Set Variable [ $r ; Value: MBS( "DynaPDF.Print.SetSetting"; "PaperSize"; 9) // A4 210 x 297 mm ]
Set Variable [ $r ; Value: MBS( "DynaPDF.Print.SetSetting"; "Orientation"; 1) ]
Set Variable [ $r ; Value: MBS( "DynaPDF.Print.SetSetting"; "PrinterName"; "Microsoft Print to PDF") ]
Set Variable [ $Flags ; Value: 16 ]
Set Variable [ $ShowDialog ; Value: 16 ]
Set Variable [ $r ; Value: MBS("DynaPDF.Print"; $pdf; ""; ""; ""; $Flags; ""; ""; ""; ""; $ShowDialog) ]

Set to print in Black & White:

Set Variable [ $r ; Value: MBS("DynaPDF.Print.SetSetting"; "Color"; 2) ] // Black & White

Set to print in Color:

Set Variable [ $r ; Value: MBS("DynaPDF.Print.SetSetting"; "Color"; 1) ] // Color

Release notes

Version 11.5
- Improved DynaPDF.Print.SetSetting to make it work better.
Version 11.4
- Added DynaPDF.Print.GetSetting and DynaPDF.Print.SetSetting functions.