Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfPageReorderPlan

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Describes a complete page permutation before a PDF page-tree mutation is applied.

Inheritance

  • Object
  • PdfPageReorderPlan

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

Methods

public Int32 GetOutputPageNumber(Int32 sourcePageNumber) #
Returns: Int32

Returns the one-based output position of a source page.

Parameters

sourcePageNumber System.Int32 requiredposition: 0
public static PdfPageReorderPlan Move(Int32 pageCount, Int32 insertBeforePageNumber, params Int32[] pageNumbers) #
Returns: PdfPageReorderPlan

Plans moving selected pages before a source page, preserving their original relative order. Use page count + 1 to move to the end. The destination cannot be selected.

Parameters

pageCount System.Int32 requiredposition: 0
insertBeforePageNumber System.Int32 requiredposition: 1
pageNumbers System.Int32[] requiredposition: 2
public static PdfPageReorderPlan Shift(Int32 pageCount, Boolean towardStart, params Int32[] pageNumbers) #
Returns: PdfPageReorderPlan

Plans shifting each selected run by one position. Runs already at the requested edge remain there.

Parameters

pageCount System.Int32 requiredposition: 0
towardStart System.Boolean requiredposition: 1
pageNumbers System.Int32[] requiredposition: 2

Properties

public IReadOnlyList<Int32> SourcePageNumbers { get; } #

One-based source page numbers in their proposed output order.

public Boolean HasChanges { get; } #

Whether the proposed order differs from the source order.