PdfDocumentAddBackgroundPdfToPage Method (Int32, String, Int32)

Adds the background to one page of this PDF. The background is copied from a page in another PDF document.

Namespace:  IronPdf
Assembly:  IronPdf (in IronPdf.dll) Version: 2020.3.2.0 (2020.3.2.0)
Syntax
public PdfDocument AddBackgroundPdfToPage(
	int ToPageIndex,
	string BackgroundPdfPath,
	int BackgroundPdfPageIndex = 0
)

Parameters

ToPageIndex
Type: SystemInt32
Index (zero-based page number) of the page of this PDF to which the background will be applied to.
BackgroundPdfPath
Type: SystemString
The background PDF path.
BackgroundPdfPageIndex (Optional)
Type: SystemInt32
Index (zero-based page number) to copy from the BackgroundPdf.

Return Value

Type: PdfDocument
Returns this PdfDocument object, allowing for a 'fluent' (LINQ like) chained in-line code style
See Also