API Reference
PdfDocumentStamper
Fluent stamping and watermarking operations for a PdfDocument.
Inheritance
- Object
- PdfDocumentStamper
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property PdfDocument.Stamp
Methods
public PdfDocument Content(Action<PdfPageCanvas, PdfStampPageContext> build, PdfCanvasStampOptions options = null, PdfReadOptions readOptions = null) #PdfDocumentStamps arbitrary visual PdfPageCanvas content onto selected existing pages. Annotations, form fields, interactive metadata, outlines, and tagged structure remain separate editor concerns and are rejected by this visual-only operation.
Parameters
- build System.Action{OfficeIMO.Pdf.PdfPageCanvas,OfficeIMO.Pdf.PdfStampPageContext}
- options OfficeIMO.Pdf.PdfCanvasStampOptions = null
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument Content(Action<PdfPageCanvas> build, PdfCanvasStampOptions options = null, PdfReadOptions readOptions = null) #PdfDocumentStamps the same arbitrary visual canvas content onto selected existing pages.
Parameters
- build System.Action{OfficeIMO.Pdf.PdfPageCanvas}
- options OfficeIMO.Pdf.PdfCanvasStampOptions = null
- readOptions OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument Image(Byte[] imageBytes, PdfImageStampOptions options = null) #PdfDocumentCreates a new PDF with an image stamped above existing content unless options request otherwise.
Parameters
- imageBytes System.Byte[]
- options OfficeIMO.Pdf.PdfImageStampOptions = null
public PdfDocument Image(Byte[] imageBytes, PdfImageStampOptions options, PdfReadOptions readOptions) #PdfDocumentCreates a new PDF with an image stamped above existing content using explicit target read options.
Parameters
- imageBytes System.Byte[]
- options OfficeIMO.Pdf.PdfImageStampOptions
- readOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument Image(Stream imageStream, PdfImageStampOptions options = null) #PdfDocumentCreates a new PDF with an image stamped from a readable image stream.
Parameters
- imageStream System.IO.Stream
- options OfficeIMO.Pdf.PdfImageStampOptions = null
public PdfDocument Image(Stream imageStream, PdfImageStampOptions options, PdfReadOptions readOptions) #PdfDocumentCreates a new PDF with an image stream stamped using explicit target read options.
Parameters
- imageStream System.IO.Stream
- options OfficeIMO.Pdf.PdfImageStampOptions
- readOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument ImageWatermark(Byte[] imageBytes, PdfImageStampOptions options = null) #PdfDocumentCreates a new PDF with an image watermarked behind existing content.
Parameters
- imageBytes System.Byte[]
- options OfficeIMO.Pdf.PdfImageStampOptions = null
public PdfDocument ImageWatermark(Byte[] imageBytes, PdfImageStampOptions options, PdfReadOptions readOptions) #PdfDocumentCreates an image watermark behind existing content using explicit target read options.
Parameters
- imageBytes System.Byte[]
- options OfficeIMO.Pdf.PdfImageStampOptions
- readOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument ImageWatermark(Stream imageStream, PdfImageStampOptions options = null) #PdfDocumentCreates a new PDF with an image watermark from a readable image stream.
Parameters
- imageStream System.IO.Stream
- options OfficeIMO.Pdf.PdfImageStampOptions = null
public PdfDocument ImageWatermark(Stream imageStream, PdfImageStampOptions options, PdfReadOptions readOptions) #PdfDocumentCreates an image-stream watermark using explicit target read options.
Parameters
- imageStream System.IO.Stream
- options OfficeIMO.Pdf.PdfImageStampOptions
- readOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument OverlayPage(Byte[] sourcePdf, PdfPageOverlayOptions options = null) #PdfDocumentImports one page from another PDF above selected pages.
Parameters
- sourcePdf System.Byte[]
- options OfficeIMO.Pdf.PdfPageOverlayOptions = null
public PdfDocument OverlayPage(Byte[] sourcePdf, PdfPageOverlayOptions options, PdfReadOptions targetReadOptions) #PdfDocumentImports one page from another PDF above selected pages using explicit target read options.
Parameters
- sourcePdf System.Byte[]
- options OfficeIMO.Pdf.PdfPageOverlayOptions
- targetReadOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument OverlayPage(Stream sourceStream, PdfPageOverlayOptions options = null) #PdfDocumentImports one page from a readable PDF stream above selected pages.
Parameters
- sourceStream System.IO.Stream
- options OfficeIMO.Pdf.PdfPageOverlayOptions = null
public PdfDocument OverlayPage(Stream sourceStream, PdfPageOverlayOptions options, PdfReadOptions targetReadOptions) #PdfDocumentImports one page from a readable PDF stream using explicit target read options.
Parameters
- sourceStream System.IO.Stream
- options OfficeIMO.Pdf.PdfPageOverlayOptions
- targetReadOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument OverlayPage(String sourcePath, PdfPageOverlayOptions options = null) #PdfDocumentImports one page from a PDF file above selected pages.
Parameters
- sourcePath System.String
- options OfficeIMO.Pdf.PdfPageOverlayOptions = null
public PdfDocument OverlayPage(String sourcePath, PdfPageOverlayOptions options, PdfReadOptions targetReadOptions) #PdfDocumentImports one page from a PDF file using explicit target read options.
Parameters
- sourcePath System.String
- options OfficeIMO.Pdf.PdfPageOverlayOptions
- targetReadOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument Text(String text, PdfTextStampOptions options = null) #PdfDocumentCreates a new PDF with text stamped above existing content unless options request otherwise.
Parameters
- text System.String
- options OfficeIMO.Pdf.PdfTextStampOptions = null
public PdfDocument Text(String text, PdfTextStampOptions options, PdfReadOptions readOptions) #PdfDocumentCreates a new PDF with text stamped above existing content using explicit target read options.
Parameters
- text System.String
- options OfficeIMO.Pdf.PdfTextStampOptions
- readOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument TextWatermark(String text, PdfTextStampOptions options = null) #PdfDocumentCreates a new PDF with text watermarked behind existing content.
Parameters
- text System.String
- options OfficeIMO.Pdf.PdfTextStampOptions = null
public PdfDocument TextWatermark(String text, PdfTextStampOptions options, PdfReadOptions readOptions) #PdfDocumentCreates a text watermark behind existing content using explicit target read options.
Parameters
- text System.String
- options OfficeIMO.Pdf.PdfTextStampOptions
- readOptions OfficeIMO.Pdf.PdfReadOptions
public PdfOperationResult<PdfDocument> TryContent(Action<PdfPageCanvas, PdfStampPageContext> build, PdfCanvasStampOptions stampOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to stamp arbitrary visual canvas content and returns diagnostics when blocked or failed.
Parameters
- build System.Action{OfficeIMO.Pdf.PdfPageCanvas,OfficeIMO.Pdf.PdfStampPageContext}
- stampOptions OfficeIMO.Pdf.PdfCanvasStampOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryImage(Byte[] imageBytes, PdfImageStampOptions stampOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to create a new PDF with an image stamped above existing content, returning diagnostics when blocked or failed.
Parameters
- imageBytes System.Byte[]
- stampOptions OfficeIMO.Pdf.PdfImageStampOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryImage(Stream imageStream, PdfImageStampOptions stampOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to create a new PDF with an image stamped from a readable image stream, returning diagnostics when blocked or failed.
Parameters
- imageStream System.IO.Stream
- stampOptions OfficeIMO.Pdf.PdfImageStampOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryImageWatermark(Byte[] imageBytes, PdfImageStampOptions stampOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to create a new PDF with an image watermarked behind existing content, returning diagnostics when blocked or failed.
Parameters
- imageBytes System.Byte[]
- stampOptions OfficeIMO.Pdf.PdfImageStampOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryImageWatermark(Stream imageStream, PdfImageStampOptions stampOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to create a new PDF with an image watermark from a readable image stream, returning diagnostics when blocked or failed.
Parameters
- imageStream System.IO.Stream
- stampOptions OfficeIMO.Pdf.PdfImageStampOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryOverlayPage(Byte[] sourcePdf, PdfPageOverlayOptions overlayOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to import one page from another PDF above selected pages.
Parameters
- sourcePdf System.Byte[]
- overlayOptions OfficeIMO.Pdf.PdfPageOverlayOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryOverlayPage(Stream sourceStream, PdfPageOverlayOptions overlayOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to import one page from a readable PDF stream above selected pages.
Parameters
- sourceStream System.IO.Stream
- overlayOptions OfficeIMO.Pdf.PdfPageOverlayOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryOverlayPage(String sourcePath, PdfPageOverlayOptions overlayOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to import one page from a PDF file above selected pages.
Parameters
- sourcePath System.String
- overlayOptions OfficeIMO.Pdf.PdfPageOverlayOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryText(String text, PdfTextStampOptions stampOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to create a new PDF with text stamped above existing content, returning diagnostics when blocked or failed.
Parameters
- text System.String
- stampOptions OfficeIMO.Pdf.PdfTextStampOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryTextWatermark(String text, PdfTextStampOptions stampOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to create a new PDF with text watermarked behind existing content, returning diagnostics when blocked or failed.
Parameters
- text System.String
- stampOptions OfficeIMO.Pdf.PdfTextStampOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryUnderlayPage(Byte[] sourcePdf, PdfPageOverlayOptions overlayOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to import one page from another PDF below selected pages.
Parameters
- sourcePdf System.Byte[]
- overlayOptions OfficeIMO.Pdf.PdfPageOverlayOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryUnderlayPage(Stream sourceStream, PdfPageOverlayOptions overlayOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to import one page from a readable PDF stream below selected pages.
Parameters
- sourceStream System.IO.Stream
- overlayOptions OfficeIMO.Pdf.PdfPageOverlayOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryUnderlayPage(String sourcePath, PdfPageOverlayOptions overlayOptions = null, PdfReadOptions options = null) #PdfOperationResult<PdfDocument>Attempts to import one page from a PDF file below selected pages.
Parameters
- sourcePath System.String
- overlayOptions OfficeIMO.Pdf.PdfPageOverlayOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument UnderlayPage(Byte[] sourcePdf, PdfPageOverlayOptions options = null) #PdfDocumentImports one page from another PDF below selected pages.
Parameters
- sourcePdf System.Byte[]
- options OfficeIMO.Pdf.PdfPageOverlayOptions = null
public PdfDocument UnderlayPage(Byte[] sourcePdf, PdfPageOverlayOptions options, PdfReadOptions targetReadOptions) #PdfDocumentImports one page from another PDF below selected pages using explicit target read options.
Parameters
- sourcePdf System.Byte[]
- options OfficeIMO.Pdf.PdfPageOverlayOptions
- targetReadOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument UnderlayPage(Stream sourceStream, PdfPageOverlayOptions options = null) #PdfDocumentImports one page from a readable PDF stream below selected pages.
Parameters
- sourceStream System.IO.Stream
- options OfficeIMO.Pdf.PdfPageOverlayOptions = null
public PdfDocument UnderlayPage(Stream sourceStream, PdfPageOverlayOptions options, PdfReadOptions targetReadOptions) #PdfDocumentImports one page from a readable PDF stream below selected pages using explicit target read options.
Parameters
- sourceStream System.IO.Stream
- options OfficeIMO.Pdf.PdfPageOverlayOptions
- targetReadOptions OfficeIMO.Pdf.PdfReadOptions
public PdfDocument UnderlayPage(String sourcePath, PdfPageOverlayOptions options = null) #PdfDocumentImports one page from a PDF file below selected pages.
Parameters
- sourcePath System.String
- options OfficeIMO.Pdf.PdfPageOverlayOptions = null
public PdfDocument UnderlayPage(String sourcePath, PdfPageOverlayOptions options, PdfReadOptions targetReadOptions) #PdfDocumentImports one page from a PDF file below selected pages using explicit target read options.
Parameters
- sourcePath System.String
- options OfficeIMO.Pdf.PdfPageOverlayOptions
- targetReadOptions OfficeIMO.Pdf.PdfReadOptions