Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfDocumentPages

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Modifiers sealed

Fluent page extraction and editing operations for a PdfDocument.

Inheritance

  • Object
  • PdfDocumentPages

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

Methods

Append 8 overloads
public PdfDocument Append(PdfDocument sourceDocument, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends all pages from another loaded or generated PDF to this document.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Append(PdfDocument sourceDocument, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends selected one-based pages from another loaded or generated PDF to this document.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Append(Byte[] sourcePdf, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends all pages from source PDF bytes to this document.

Parameters

sourcePdf System.Byte[] requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Append(Byte[] sourcePdf, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends selected one-based pages from source PDF bytes to this document.

Parameters

sourcePdf System.Byte[] requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Append(Stream sourceStream, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends all pages from a readable source PDF stream to this document.

Parameters

sourceStream System.IO.Stream requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Append(Stream sourceStream, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends selected one-based pages from a readable source PDF stream to this document.

Parameters

sourceStream System.IO.Stream requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Append(String sourcePath, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends all pages from a source PDF file to this document.

Parameters

sourcePath System.String requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Append(String sourcePath, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Appends selected one-based pages from a source PDF file to this document.

Parameters

sourcePath System.String requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
AppendResult 8 overloads
public PdfOperationResult<PdfDocument> AppendResult(PdfDocument sourceDocument, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append pages from another loaded or generated PDF, returning diagnostics when blocked or failed.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> AppendResult(PdfDocument sourceDocument, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append selected pages from another loaded or generated PDF, returning diagnostics when blocked or failed.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> AppendResult(Byte[] sourcePdf, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append source PDF bytes, returning diagnostics when blocked or failed.

Parameters

sourcePdf System.Byte[] requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> AppendResult(Byte[] sourcePdf, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append selected pages from source PDF bytes, returning diagnostics when blocked or failed.

Parameters

sourcePdf System.Byte[] requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> AppendResult(Stream sourceStream, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append a readable source PDF stream, returning diagnostics when blocked or failed.

Parameters

sourceStream System.IO.Stream requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> AppendResult(Stream sourceStream, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append selected pages from a readable source PDF stream, returning diagnostics when blocked or failed.

Parameters

sourceStream System.IO.Stream requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> AppendResult(String sourcePath, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append a source PDF file, returning diagnostics when blocked or failed.

Parameters

sourcePath System.String requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> AppendResult(String sourcePath, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to append selected pages from a source PDF file, returning diagnostics when blocked or failed.

Parameters

sourcePath System.String requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfDocument ApplyAttributes(params PdfPageAttributeEdit[] edits) #
Returns: PdfDocument

Applies ordered page-attribute edits atomically through one output revision or rewrite.

Parameters

edits OfficeIMO.Pdf.PdfPageAttributeEdit[] requiredposition: 0
public PdfOperationResult<PdfDocument> ApplyAttributesResult(IReadOnlyList<PdfPageAttributeEdit> edits, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #
Returns: PdfOperationResult<PdfDocument>

Applies an atomic page-attribute batch and reports the route, reasons and blockers.

Parameters

edits System.Collections.Generic.IReadOnlyList<OfficeIMO.Pdf.PdfPageAttributeEdit> requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2

Exceptions

  • OperationCanceledException – The requested cancellation interrupts planning, editing or output adoption.
public IReadOnlyList<PdfBookmarkPageRange> BookmarkPageRanges(params String[] bookmarkTitles) #
Returns: IReadOnlyList<PdfBookmarkPageRange>

Returns outline/bookmark-derived page ranges in document order.

Parameters

bookmarkTitles System.String[] requiredposition: 0
public PdfDocument CropAndTranslate(Double left, Double bottom, Double right, Double top, params Int32[] pageNumbers) #
Returns: PdfDocument

Non-destructively crops selected pages and translates the chosen source rectangle to a zero-based page origin. Content outside the rectangle remains in source streams but is clipped from display.

Parameters

left System.Double requiredposition: 0
bottom System.Double requiredposition: 1
right System.Double requiredposition: 2
top System.Double requiredposition: 3
pageNumbers System.Int32[] requiredposition: 4
Delete 5 overloads
public PdfDocument Delete(params Int32[] pageNumbers) #
Returns: PdfDocument

Creates a new PDF with selected pages deleted.

Parameters

pageNumbers System.Int32[] requiredposition: 0
public PdfDocument Delete(PdfPageRange pageRange) #
Returns: PdfDocument

Creates a new PDF with one inclusive page range deleted.

Parameters

pageRange OfficeIMO.Pdf.PdfPageRange requiredposition: 0
public PdfDocument Delete(PdfPageSelection selection) #
Returns: PdfDocument

Creates a new PDF with selected pages deleted.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
public PdfDocument Delete(String pageRanges) #
Returns: PdfDocument

Creates a new PDF with comma- or semicolon-separated inclusive page ranges deleted.

Parameters

pageRanges System.String requiredposition: 0
public PdfDocument Delete(PdfPageSelector selector) #
Returns: PdfDocument

Creates a new PDF with pages resolved from a document-relative selector deleted.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
DeleteResult 3 overloads
public PdfOperationResult<PdfDocument> DeleteResult(PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with selected pages deleted, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> DeleteResult(String pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with pages described by page ranges deleted, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> DeleteResult(PdfPageSelector selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to delete pages resolved from a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfDestructiveCropResult DestructiveCrop(Double left, Double bottom, Double right, Double top, PdfDestructiveCropOptions? options = null, params Int32[] pageNumbers) #
Returns: PdfDestructiveCropResult

Destructively crops selected pages by replacing the retained visual rectangle with a validated opaque raster page.

Parameters

left System.Double requiredposition: 0
bottom System.Double requiredposition: 1
right System.Double requiredposition: 2
top System.Double requiredposition: 3
options OfficeIMO.Pdf.PdfDestructiveCropOptions? = null optionalposition: 4
pageNumbers System.Int32[] requiredposition: 5
Duplicate 5 overloads
public PdfDocument Duplicate(params Int32[] pageNumbers) #
Returns: PdfDocument

Creates a new PDF with selected pages duplicated immediately after each source page.

Parameters

pageNumbers System.Int32[] requiredposition: 0
public PdfDocument Duplicate(PdfPageRange pageRange) #
Returns: PdfDocument

Creates a new PDF with one inclusive page range duplicated.

Parameters

pageRange OfficeIMO.Pdf.PdfPageRange requiredposition: 0
public PdfDocument Duplicate(PdfPageSelection selection) #
Returns: PdfDocument

Creates a new PDF with selected pages duplicated immediately after each source page.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
public PdfDocument Duplicate(String pageRanges) #
Returns: PdfDocument

Creates a new PDF with parsed page ranges duplicated.

Parameters

pageRanges System.String requiredposition: 0
public PdfDocument Duplicate(PdfPageSelector selector) #
Returns: PdfDocument

Creates a new PDF with pages resolved from a document-relative selector duplicated.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
DuplicateResult 3 overloads
public PdfOperationResult<PdfDocument> DuplicateResult(PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with selected pages duplicated, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> DuplicateResult(String pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with parsed page ranges duplicated, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> DuplicateResult(PdfPageSelector selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to duplicate pages resolved from a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
Extract 6 overloads
public PdfDocument Extract(params Int32[] pageNumbers) #
Returns: PdfDocument

Creates a new PDF containing selected pages in caller order.

Parameters

pageNumbers System.Int32[] requiredposition: 0
public PdfDocument Extract(CancellationToken cancellationToken, params Int32[] pageNumbers) #
Returns: PdfDocument

Creates a new PDF containing selected pages in caller order with cooperative cancellation.

Parameters

cancellationToken System.Threading.CancellationToken requiredposition: 0
pageNumbers System.Int32[] requiredposition: 1
public PdfDocument Extract(PdfPageRange pageRange) #
Returns: PdfDocument

Creates a new PDF containing one inclusive one-based page range.

Parameters

pageRange OfficeIMO.Pdf.PdfPageRange requiredposition: 0
public PdfDocument Extract(PdfPageSelection selection) #
Returns: PdfDocument

Creates a new PDF containing selected pages in caller order.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
public PdfDocument Extract(String pageRanges) #
Returns: PdfDocument

Creates a new PDF containing comma- or semicolon-separated inclusive page ranges.

Parameters

pageRanges System.String requiredposition: 0
public PdfDocument Extract(PdfPageSelector selector) #
Returns: PdfDocument

Creates a new PDF containing pages resolved from a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
ExtractResult 3 overloads
public PdfOperationResult<PdfDocument> ExtractResult(PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF containing selected pages in caller order, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> ExtractResult(String pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF containing pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> ExtractResult(PdfPageSelector selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to extract pages resolved from a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfImpositionResult ImposeBooklet(PdfBookletOptions options, PdfPageSelection? selection = null) #
Returns: PdfImpositionResult

Creates a two-up duplex booklet in front/back print order. Source pages become visual sheet content.

Parameters

options OfficeIMO.Pdf.PdfBookletOptions requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 1
public PdfImpositionResult ImposeNUp(PdfNUpOptions options, PdfPageSelection? selection = null) #
Returns: PdfImpositionResult

Places selected source pages onto printable sheets as vector page content and returns their cell mapping.

Parameters

options OfficeIMO.Pdf.PdfNUpOptions requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 1
Insert 8 overloads
public PdfDocument Insert(Int32 insertBeforePageNumber, PdfDocument sourceDocument, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts all pages from another loaded or generated PDF before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Insert(Int32 insertBeforePageNumber, PdfDocument sourceDocument, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts selected one-based pages from another loaded or generated PDF before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
public PdfDocument Insert(Int32 insertBeforePageNumber, Byte[] sourcePdf, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts all pages from source PDF bytes before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePdf System.Byte[] requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Insert(Int32 insertBeforePageNumber, Byte[] sourcePdf, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts selected one-based pages from source PDF bytes before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePdf System.Byte[] requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
public PdfDocument Insert(Int32 insertBeforePageNumber, Stream sourceStream, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts all pages from a readable source PDF stream before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceStream System.IO.Stream requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Insert(Int32 insertBeforePageNumber, Stream sourceStream, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts selected one-based pages from a readable source PDF stream before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceStream System.IO.Stream requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
public PdfDocument Insert(Int32 insertBeforePageNumber, String sourcePath, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts all pages from a source PDF file before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePath System.String requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Insert(Int32 insertBeforePageNumber, String sourcePath, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Inserts selected one-based pages from a source PDF file before the supplied one-based page number. Use target page count + 1 to insert at the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePath System.String requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
InsertResult 8 overloads
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, PdfDocument sourceDocument, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert pages from another loaded or generated PDF, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, PdfDocument sourceDocument, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert selected pages from another loaded or generated PDF, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, Byte[] sourcePdf, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert source PDF bytes before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePdf System.Byte[] requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, Byte[] sourcePdf, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert selected pages from source PDF bytes before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePdf System.Byte[] requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, Stream sourceStream, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert a readable source PDF stream before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceStream System.IO.Stream requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, Stream sourceStream, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert selected pages from a readable source PDF stream before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourceStream System.IO.Stream requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, String sourcePath, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert a source PDF file before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePath System.String requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> InsertResult(Int32 insertBeforePageNumber, String sourcePath, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to insert selected pages from a source PDF file before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
sourcePath System.String requiredposition: 1
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 2
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 3
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 4
Move 5 overloads
public PdfDocument Move(Int32 insertBeforePageNumber, params Int32[] pageNumbers) #
Returns: PdfDocument

Creates a new PDF with selected pages moved before the supplied one-based page number. Use page count + 1 to move pages to the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
pageNumbers System.Int32[] requiredposition: 1
public PdfDocument Move(Int32 insertBeforePageNumber, PdfPageRange pageRange) #
Returns: PdfDocument

Creates a new PDF with one inclusive page range moved before the supplied one-based page number. Use page count + 1 to move pages to the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
pageRange OfficeIMO.Pdf.PdfPageRange requiredposition: 1
public PdfDocument Move(Int32 insertBeforePageNumber, PdfPageSelection selection) #
Returns: PdfDocument

Creates a new PDF with selected pages moved before the supplied one-based page number. Use page count + 1 to move pages to the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
public PdfDocument Move(Int32 insertBeforePageNumber, String pageRanges) #
Returns: PdfDocument

Creates a new PDF with parsed page ranges moved before the supplied one-based page number. Use page count + 1 to move pages to the end.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
pageRanges System.String requiredposition: 1
public PdfDocument Move(Int32 insertBeforePageNumber, PdfPageSelector selector) #
Returns: PdfDocument

Moves pages resolved from a document-relative selector before a one-based page number.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 1
MoveResult 3 overloads
public PdfOperationResult<PdfDocument> MoveResult(Int32 insertBeforePageNumber, PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with selected pages moved before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> MoveResult(Int32 insertBeforePageNumber, String pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with parsed page ranges moved before the supplied one-based page number, returning diagnostics when blocked or failed.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
pageRanges System.String requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> MoveResult(Int32 insertBeforePageNumber, PdfPageSelector selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to move pages resolved from a document-relative selector.

Parameters

insertBeforePageNumber System.Int32 requiredposition: 0
selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfDocument NormalizeRotation(PdfPageSelection? selection = null, CancellationToken cancellationToken = default) #
Returns: PdfDocument

Bakes selected pages' effective quarter-turn rotation into their content and geometry while preserving appearance.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 0
cancellationToken System.Threading.CancellationToken = default optionalposition: 1
public PdfOperationResult<PdfDocument> NormalizeRotationResult(PdfPageSelection? selection = null, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #
Returns: PdfOperationResult<PdfDocument>

Normalizes saved rotation and reports the rewrite route and restrictions.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2

Exceptions

  • OperationCanceledException – The caller requests cancellation.
Prepend 8 overloads
public PdfDocument Prepend(PdfDocument sourceDocument, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends all pages from another loaded or generated PDF before this document.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Prepend(PdfDocument sourceDocument, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends selected one-based pages from another loaded or generated PDF before this document.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Prepend(Byte[] sourcePdf, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends all pages from source PDF bytes before this document.

Parameters

sourcePdf System.Byte[] requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Prepend(Byte[] sourcePdf, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends selected one-based pages from source PDF bytes before this document.

Parameters

sourcePdf System.Byte[] requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Prepend(Stream sourceStream, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends all pages from a readable source PDF stream before this document.

Parameters

sourceStream System.IO.Stream requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Prepend(Stream sourceStream, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends selected one-based pages from a readable source PDF stream before this document.

Parameters

sourceStream System.IO.Stream requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
public PdfDocument Prepend(String sourcePath, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends all pages from a source PDF file before this document.

Parameters

sourcePath System.String requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
public PdfDocument Prepend(String sourcePath, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null) #
Returns: PdfDocument

Prepends selected one-based pages from a source PDF file before this document.

Parameters

sourcePath System.String requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
PrependResult 8 overloads
public PdfOperationResult<PdfDocument> PrependResult(PdfDocument sourceDocument, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend pages from another loaded or generated PDF, returning diagnostics when blocked or failed.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> PrependResult(PdfDocument sourceDocument, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend selected pages from another loaded or generated PDF, returning diagnostics when blocked or failed.

Parameters

sourceDocument OfficeIMO.Pdf.PdfDocument requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> PrependResult(Byte[] sourcePdf, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend source PDF bytes, returning diagnostics when blocked or failed.

Parameters

sourcePdf System.Byte[] requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> PrependResult(Byte[] sourcePdf, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend selected pages from source PDF bytes, returning diagnostics when blocked or failed.

Parameters

sourcePdf System.Byte[] requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> PrependResult(Stream sourceStream, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend a readable source PDF stream, returning diagnostics when blocked or failed.

Parameters

sourceStream System.IO.Stream requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> PrependResult(Stream sourceStream, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend selected pages from a readable source PDF stream, returning diagnostics when blocked or failed.

Parameters

sourceStream System.IO.Stream requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
public PdfOperationResult<PdfDocument> PrependResult(String sourcePath, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend a source PDF file, returning diagnostics when blocked or failed.

Parameters

sourcePath System.String requiredposition: 0
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> PrependResult(String sourcePath, PdfPageSelection sourceSelection, PdfPageImportOptions? importOptions = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to prepend selected pages from a source PDF file, returning diagnostics when blocked or failed.

Parameters

sourcePath System.String requiredposition: 0
sourceSelection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
importOptions OfficeIMO.Pdf.PdfPageImportOptions? = null optionalposition: 2
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 3
Reorder 4 overloads
public PdfDocument Reorder(params Int32[] pageNumbers) #
Returns: PdfDocument

Creates a new PDF with every page copied in the specified one-based order.

Parameters

pageNumbers System.Int32[] requiredposition: 0
public PdfDocument Reorder(String pageRanges) #
Returns: PdfDocument

Creates a new PDF with every page copied in parsed page-range order.

Parameters

pageRanges System.String requiredposition: 0
public PdfDocument Reorder(PdfPageSelection selection) #
Returns: PdfDocument

Creates a new PDF with every page copied in the selected one-based order.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
public PdfDocument Reorder(PdfPageSelector selector) #
Returns: PdfDocument

Creates a new PDF with pages copied in the order resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
ReorderResult 3 overloads
public PdfOperationResult<PdfDocument> ReorderResult(PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with every page copied in the selected one-based order, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> ReorderResult(String pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with pages copied in parsed page-range order, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<PdfDocument> ReorderResult(PdfPageSelector selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to reorder pages resolved from a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfPageRewriteResult ReorderWithMapping(params Int32[] pageNumbers) #
Returns: PdfPageRewriteResult

Reorders every page and reports the object numbers needed to retain annotation or object selections.

Parameters

pageNumbers System.Int32[] requiredposition: 0
Resize 2 overloads
public PdfDocument Resize(PageSize pageSize, params Int32[] pageNumbers) #
Returns: PdfDocument

Resizes selected pages to the supplied page size.

Parameters

pageSize OfficeIMO.Pdf.PageSize requiredposition: 0
pageNumbers System.Int32[] requiredposition: 1
public PdfDocument Resize(PdfPageResizeOptions options, params Int32[] pageNumbers) #
Returns: PdfDocument

Resizes selected pages with explicit fit, fill, alignment, and scaling settings.

Parameters

options OfficeIMO.Pdf.PdfPageResizeOptions requiredposition: 0
pageNumbers System.Int32[] requiredposition: 1
Rotate 5 overloads
public PdfDocument Rotate(Int32 rotationDegrees, params Int32[] pageNumbers) #
Returns: PdfDocument

Creates a new PDF with selected pages rotated. Supplying no page numbers rotates every page.

Parameters

rotationDegrees System.Int32 requiredposition: 0
pageNumbers System.Int32[] requiredposition: 1
public PdfDocument Rotate(Int32 rotationDegrees, PdfPageRange pageRange) #
Returns: PdfDocument

Creates a new PDF with one inclusive page range rotated.

Parameters

rotationDegrees System.Int32 requiredposition: 0
pageRange OfficeIMO.Pdf.PdfPageRange requiredposition: 1
public PdfDocument Rotate(Int32 rotationDegrees, PdfPageSelection selection) #
Returns: PdfDocument

Creates a new PDF with selected pages rotated.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
public PdfDocument Rotate(Int32 rotationDegrees, String pageRanges) #
Returns: PdfDocument

Creates a new PDF with parsed page ranges rotated.

Parameters

rotationDegrees System.Int32 requiredposition: 0
pageRanges System.String requiredposition: 1
public PdfDocument Rotate(Int32 rotationDegrees, PdfPageSelector selector) #
Returns: PdfDocument

Rotates pages resolved from a document-relative selector.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 1
RotateBy 4 overloads
public PdfDocument RotateBy(Int32 rotationDegrees, params Int32[] pageNumbers) #
Returns: PdfDocument

Turns selected pages by a multiple of 90 degrees relative to each page's effective rotation. Positive values turn clockwise. If no page numbers are supplied, all pages are turned. Mixed inherited rotations are resolved independently in one mutation.

Parameters

rotationDegrees System.Int32 requiredposition: 0
pageNumbers System.Int32[] requiredposition: 1
public PdfDocument RotateBy(Int32 rotationDegrees, PdfPageSelection selection) #
Returns: PdfDocument

Turns the selected pages relative to their effective rotation.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
public PdfDocument RotateBy(Int32 rotationDegrees, PdfPageSelector selector) #
Returns: PdfDocument

Turns pages resolved by a document-relative selector.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 1
public PdfDocument RotateBy(Int32 rotationDegrees, String selector) #
Returns: PdfDocument

Turns pages resolved by a document-relative selection expression.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selector System.String requiredposition: 1
RotateByResult 3 overloads
public PdfOperationResult<PdfDocument> RotateByResult(Int32 rotationDegrees, PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Turns selected pages and reports the mutation route and preservation restrictions.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> RotateByResult(Int32 rotationDegrees, PdfPageSelector selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Turns pages resolved by a document-relative selector and reports the mutation route.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> RotateByResult(Int32 rotationDegrees, String selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Turns pages resolved by a document-relative expression and reports the mutation route.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selector System.String requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
RotateResult 3 overloads
public PdfOperationResult<PdfDocument> RotateResult(Int32 rotationDegrees, PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with selected pages rotated, returning diagnostics when blocked or failed.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> RotateResult(Int32 rotationDegrees, String pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to create a new PDF with parsed page ranges rotated, returning diagnostics when blocked or failed.

Parameters

rotationDegrees System.Int32 requiredposition: 0
pageRanges System.String requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfOperationResult<PdfDocument> RotateResult(Int32 rotationDegrees, PdfPageSelector selector, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Attempts to rotate pages resolved from a document-relative selector.

Parameters

rotationDegrees System.Int32 requiredposition: 0
selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 1
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 2
public PdfDocument SetArtBox(Double left, Double bottom, Double right, Double top, params Int32[] pageNumbers) #
Returns: PdfDocument

Sets the art box for selected pages.

Parameters

left System.Double requiredposition: 0
bottom System.Double requiredposition: 1
right System.Double requiredposition: 2
top System.Double requiredposition: 3
pageNumbers System.Int32[] requiredposition: 4
public PdfDocument SetBleedBox(Double left, Double bottom, Double right, Double top, params Int32[] pageNumbers) #
Returns: PdfDocument

Sets the bleed box for selected pages.

Parameters

left System.Double requiredposition: 0
bottom System.Double requiredposition: 1
right System.Double requiredposition: 2
top System.Double requiredposition: 3
pageNumbers System.Int32[] requiredposition: 4
public PdfDocument SetCropBox(Double left, Double bottom, Double right, Double top, params Int32[] pageNumbers) #
Returns: PdfDocument

Sets the crop box for selected pages.

Parameters

left System.Double requiredposition: 0
bottom System.Double requiredposition: 1
right System.Double requiredposition: 2
top System.Double requiredposition: 3
pageNumbers System.Int32[] requiredposition: 4
public PdfDocument SetMediaBox(Double left, Double bottom, Double right, Double top, params Int32[] pageNumbers) #
Returns: PdfDocument

Sets the media box for selected pages.

Parameters

left System.Double requiredposition: 0
bottom System.Double requiredposition: 1
right System.Double requiredposition: 2
top System.Double requiredposition: 3
pageNumbers System.Int32[] requiredposition: 4
public PdfDocument SetPageBox(PdfPageBoundaryBox box, Double left, Double bottom, Double right, Double top, params Int32[] pageNumbers) #
Returns: PdfDocument

Sets a typed boundary box for selected pages, or every page when no page numbers are supplied.

Parameters

box OfficeIMO.Pdf.PdfPageBoundaryBox requiredposition: 0
left System.Double requiredposition: 1
bottom System.Double requiredposition: 2
right System.Double requiredposition: 3
top System.Double requiredposition: 4
pageNumbers System.Int32[] requiredposition: 5
public PdfOperationResult<PdfDocument> SetPageBoxResult(PdfPageBoundaryBox box, Double left, Double bottom, Double right, Double top, PdfPageSelection selection, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<PdfDocument>

Sets a page boundary box and returns the chosen mutation route, its reasons, and any blockers. This changes page geometry without translating or removing source content.

Parameters

box OfficeIMO.Pdf.PdfPageBoundaryBox requiredposition: 0
left System.Double requiredposition: 1
bottom System.Double requiredposition: 2
right System.Double requiredposition: 3
top System.Double requiredposition: 4
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 5
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 6
public PdfDocument SetTrimBox(Double left, Double bottom, Double right, Double top, params Int32[] pageNumbers) #
Returns: PdfDocument

Sets the trim box for selected pages.

Parameters

left System.Double requiredposition: 0
bottom System.Double requiredposition: 1
right System.Double requiredposition: 2
top System.Double requiredposition: 3
pageNumbers System.Int32[] requiredposition: 4
Split 5 overloads
public IReadOnlyList<PdfDocument> Split() #
Returns: IReadOnlyList<PdfDocument>

Creates one PDF per page.

public IReadOnlyList<PdfDocument> Split(Int32 pagesPerDocument) #
Returns: IReadOnlyList<PdfDocument>

Creates PDFs containing consecutive groups of the requested page count.

Parameters

pagesPerDocument System.Int32 requiredposition: 0
public IReadOnlyList<PdfDocument> Split(params PdfPageSelection[] selections) #
Returns: IReadOnlyList<PdfDocument>

Creates one PDF for each supplied page selection.

Parameters

selections OfficeIMO.Pdf.PdfPageSelection[] requiredposition: 0
public IReadOnlyList<PdfDocument> Split(IEnumerable<PdfPageRange> pageRanges) #
Returns: IReadOnlyList<PdfDocument>

Creates one PDF for each supplied inclusive page range.

Parameters

pageRanges System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfPageRange> requiredposition: 0
public IReadOnlyList<PdfDocument> Split(String pageRanges) #
Returns: IReadOnlyList<PdfDocument>

Creates one PDF for each comma- or semicolon-separated inclusive page range.

Parameters

pageRanges System.String requiredposition: 0
public IReadOnlyList<PdfDocument> SplitByBookmarks(params String[] bookmarkTitles) #
Returns: IReadOnlyList<PdfDocument>

Creates one PDF for each outline/bookmark-derived page range.

Parameters

bookmarkTitles System.String[] requiredposition: 0
public PdfOperationResult<IReadOnlyList<PdfDocument>> SplitByBookmarksResult(IReadOnlyList<String>? bookmarkTitles = null, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<IReadOnlyList<PdfDocument>>

Attempts to create one PDF for each outline/bookmark-derived page range.

Parameters

bookmarkTitles System.Collections.Generic.IReadOnlyList<System.String>? = null optionalposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public IReadOnlyList<PdfProductionSplitPart> SplitForProduction(PdfProductionSplitOptions options) #
Returns: IReadOnlyList<PdfProductionSplitPart>

Splits this document using bounded page-count, target-size, and content-boundary production rules.

Parameters

options OfficeIMO.Pdf.PdfProductionSplitOptions requiredposition: 0
public PdfProductionSplitResult SplitForProductionResult(PdfProductionSplitOptions options) #
Returns: PdfProductionSplitResult

Splits this document and returns the generated parts with bounded-probe evidence.

Parameters

options OfficeIMO.Pdf.PdfProductionSplitOptions requiredposition: 0
SplitResult 5 overloads
public PdfOperationResult<IReadOnlyList<PdfDocument>> SplitResult(PdfLoadOptions? options = null) #
Returns: PdfOperationResult<IReadOnlyList<PdfDocument>>

Attempts to create one PDF per page, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfDocument>> SplitResult(Int32 pagesPerDocument, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<IReadOnlyList<PdfDocument>>

Attempts to create PDFs containing consecutive groups of the requested page count.

Parameters

pagesPerDocument System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfDocument>> SplitResult(IReadOnlyList<PdfPageSelection> selections, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<IReadOnlyList<PdfDocument>>

Attempts to create one PDF for each supplied page selection.

Parameters

selections System.Collections.Generic.IReadOnlyList<OfficeIMO.Pdf.PdfPageSelection> requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfDocument>> SplitResult(IEnumerable<PdfPageRange> pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<IReadOnlyList<PdfDocument>>

Attempts to create one PDF for each supplied inclusive page range, returning diagnostics when blocked or failed.

Parameters

pageRanges System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfPageRange> requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfDocument>> SplitResult(String pageRanges, PdfLoadOptions? options = null) #
Returns: PdfOperationResult<IReadOnlyList<PdfDocument>>

Attempts to create one PDF for each parsed page range, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfLoadOptions? = null optionalposition: 1