API Reference
PdfDocumentStamper
Fluent stamping and watermarking operations for a PdfDocument.
Inheritance
- Object
- PdfDocumentStamper
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Property PdfDocument.Stamp
Methods
public PdfDocument Content(Action<PdfPageCanvas, PdfStampPageContext> build, PdfCanvasStampOptions? options = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfDocument Content(Action<PdfPageCanvas> build, PdfCanvasStampOptions? options = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfOperationResult<PdfDocument> ContentResult(Action<PdfPageCanvas, PdfStampPageContext> build, PdfCanvasStampOptions? stampOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = 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, PdfLoadOptions? 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.PdfLoadOptions?
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, PdfLoadOptions? 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.PdfLoadOptions?
public PdfOperationResult<PdfDocument> ImageResult(Byte[] imageBytes, PdfImageStampOptions? stampOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfOperationResult<PdfDocument> ImageResult(Stream imageStream, PdfImageStampOptions? stampOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
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, PdfLoadOptions? readOptions) #PdfDocumentCreates an image watermark behind existing content using explicit target read options.
Parameters
- imageBytes System.Byte[]
- options OfficeIMO.Pdf.PdfImageStampOptions?
- readOptions OfficeIMO.Pdf.PdfLoadOptions?
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, PdfLoadOptions? readOptions) #PdfDocumentCreates an image-stream watermark using explicit target read options.
Parameters
- imageStream System.IO.Stream
- options OfficeIMO.Pdf.PdfImageStampOptions?
- readOptions OfficeIMO.Pdf.PdfLoadOptions?
public PdfOperationResult<PdfDocument> ImageWatermarkResult(Byte[] imageBytes, PdfImageStampOptions? stampOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfOperationResult<PdfDocument> ImageWatermarkResult(Stream imageStream, PdfImageStampOptions? stampOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
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, PdfLoadOptions? 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.PdfLoadOptions?
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, PdfLoadOptions? 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.PdfLoadOptions?
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, PdfLoadOptions? targetReadOptions) #PdfDocumentImports one page from a PDF file using explicit target read options.
Parameters
- sourcePath System.String
- options OfficeIMO.Pdf.PdfPageOverlayOptions?
- targetReadOptions OfficeIMO.Pdf.PdfLoadOptions?
public PdfOperationResult<PdfDocument> OverlayPageResult(Byte[] sourcePdf, PdfPageOverlayOptions? overlayOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfOperationResult<PdfDocument> OverlayPageResult(Stream sourceStream, PdfPageOverlayOptions? overlayOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfOperationResult<PdfDocument> OverlayPageResult(String sourcePath, PdfPageOverlayOptions? overlayOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public IReadOnlyList<PdfWatermarkOptions> ReadWatermarks(PdfLoadOptions? readOptions = null) #IReadOnlyList<PdfWatermarkOptions>Reads editable settings for watermarks created by this API, with their current page selections.
Parameters
- readOptions OfficeIMO.Pdf.PdfLoadOptions? = null
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, PdfLoadOptions? 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.PdfLoadOptions?
public PdfOperationResult<PdfDocument> TextResult(String text, PdfTextStampOptions? stampOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
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, PdfLoadOptions? readOptions) #PdfDocumentCreates a text watermark behind existing content using explicit target read options.
Parameters
- text System.String
- options OfficeIMO.Pdf.PdfTextStampOptions?
- readOptions OfficeIMO.Pdf.PdfLoadOptions?
public PdfOperationResult<PdfDocument> TextWatermarkResult(String text, PdfTextStampOptions? stampOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = 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, PdfLoadOptions? 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.PdfLoadOptions?
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, PdfLoadOptions? 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.PdfLoadOptions?
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, PdfLoadOptions? 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.PdfLoadOptions?
public PdfOperationResult<PdfDocument> UnderlayPageResult(Byte[] sourcePdf, PdfPageOverlayOptions? overlayOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfOperationResult<PdfDocument> UnderlayPageResult(Stream sourceStream, PdfPageOverlayOptions? overlayOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfOperationResult<PdfDocument> UnderlayPageResult(String sourcePath, PdfPageOverlayOptions? overlayOptions = null, PdfLoadOptions? 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.PdfLoadOptions? = null
public PdfDocument Watermark(PdfWatermarkOptions options, PdfLoadOptions? readOptions = null) #PdfDocumentAdds or revises a text or image watermark with a centered rotation origin and common opacity, placement, and page-selection options. Reusing an identifier replaces that watermark on the requested pages and removes its previous occurrences on other pages. An unchanged foreground or background setting preserves its position relative to other page content.
Parameters
- options OfficeIMO.Pdf.PdfWatermarkOptions
- readOptions OfficeIMO.Pdf.PdfLoadOptions? = null
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?