PageClientPrintToPDFAsync Method

public Task<PrintToPDFResponse> PrintToPDFAsync(
	bool? landscape = null,
	bool? displayHeaderFooter = null,
	bool? printBackground = null,
	double? scale = null,
	double? paperWidth = null,
	double? paperHeight = null,
	double? marginTop = null,
	double? marginBottom = null,
	double? marginLeft = null,
	double? marginRight = null,
	string pageRanges = null,
	bool? ignoreInvalidPageRanges = null,
	string headerTemplate = null,
	string footerTemplate = null,
	bool? preferCSSPageSize = null,
	PrintToPDFTransferMode? transferMode = null
)

public:
Task<PrintToPDFResponse^>^ PrintToPDFAsync(
	Nullable<bool> landscape = nullptr, 
	Nullable<bool> displayHeaderFooter = nullptr, 
	Nullable<bool> printBackground = nullptr, 
	Nullable<double> scale = nullptr, 
	Nullable<double> paperWidth = nullptr, 
	Nullable<double> paperHeight = nullptr, 
	Nullable<double> marginTop = nullptr, 
	Nullable<double> marginBottom = nullptr, 
	Nullable<double> marginLeft = nullptr, 
	Nullable<double> marginRight = nullptr, 
	String^ pageRanges = nullptr, 
	Nullable<bool> ignoreInvalidPageRanges = nullptr, 
	String^ headerTemplate = nullptr, 
	String^ footerTemplate = nullptr, 
	Nullable<bool> preferCSSPageSize = nullptr, 
	Nullable<PrintToPDFTransferMode> transferMode = nullptr
)

Parameters

landscape (Optional)

Type: SystemNullableBoolean
Paper orientation. Defaults to false.

displayHeaderFooter (Optional)

Type: SystemNullableBoolean
Display header and footer. Defaults to false.

printBackground (Optional)

Type: SystemNullableBoolean
Print background graphics. Defaults to false.

scale (Optional)

Type: SystemNullableDouble
Scale of the webpage rendering. Defaults to 1.

paperWidth (Optional)

Type: SystemNullableDouble
Paper width in inches. Defaults to 8.5 inches.

paperHeight (Optional)

Type: SystemNullableDouble
Paper height in inches. Defaults to 11 inches.

marginTop (Optional)

Type: SystemNullableDouble
Top margin in inches. Defaults to 1cm (~0.4 inches).

marginBottom (Optional)

Type: SystemNullableDouble
Bottom margin in inches. Defaults to 1cm (~0.4 inches).

marginLeft (Optional)

Type: SystemNullableDouble
Left margin in inches. Defaults to 1cm (~0.4 inches).

marginRight (Optional)

Type: SystemNullableDouble
Right margin in inches. Defaults to 1cm (~0.4 inches).

pageRanges (Optional)

Type: SystemString
Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which meansprint all pages.

ignoreInvalidPageRanges (Optional)

Type: SystemNullableBoolean
Whether to silently ignore invalid but successfully parsed page ranges, such as '3-2'.Defaults to false.

headerTemplate (Optional)

Type: SystemString
HTML template for the print header. Should be valid HTML markup with followingclasses used to inject printing values into them:- `date`: formatted print date- `title`: document title- `url`: document location- `pageNumber`: current page number- `totalPages`: total pages in the documentFor example, `<span class=title> </span>` would generate span containing the title.

footerTemplate (Optional)

Type: SystemString
HTML template for the print footer. Should use the same format as the `headerTemplate`.

preferCSSPageSize (Optional)

Type: SystemNullableBoolean
Whether or not to prefer page size as defined by css. Defaults to false,in which case the content will be scaled to fit the paper size.

transferMode (Optional)

Type: SystemNullablePrintToPDFTransferMode
return as stream

Return Value

Reference