Get Started

API Reference

Class

PdfPageSelection

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:39
Implements
IEquatable<PdfPageSelection>
Modifiers sealed

Represents caller-ordered one-based PDF page selections.

Inheritance

  • Object
  • PdfPageSelection

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

Accepted by parameters

Methods

Equals 2 overloads
public virtual Boolean Equals(PdfPageSelection other) #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:101
Returns: Boolean

Parameters

other OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
public override Boolean Equals(Object obj) #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:120
Returns: Boolean

Parameters

obj System.Object requiredposition: 0
From 2 overloads
public static PdfPageSelection From(params Int32[] pageNumbers) #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:39
Returns: PdfPageSelection

Creates a selection from one or more one-based page numbers.

Parameters

pageNumbers System.Int32[] requiredposition: 0
public static PdfPageSelection From(PdfPageRange pageRange) #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:56
Returns: PdfPageSelection

Creates a selection from one inclusive one-based page range.

Parameters

pageRange OfficeIMO.Pdf.PdfPageRange requiredposition: 0
public static PdfPageSelection FromRanges(params PdfPageRange[] pageRanges) #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:63
Returns: PdfPageSelection

Creates a selection from one or more inclusive one-based page ranges.

Parameters

pageRanges OfficeIMO.Pdf.PdfPageRange[] requiredposition: 0
public override Int32 GetHashCode() #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:126
Returns: Int32
public static PdfPageSelection Parse(String pageRanges) #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:75
Returns: PdfPageSelection

Parses comma- or semicolon-separated one-based page ranges such as 1, 1-3, or 3,1-2.

Parameters

pageRanges System.String requiredposition: 0
public override String ToString() #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:137
Returns: String
public static Boolean TryParse(String pageRanges, out PdfPageSelection selection) #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:82
Returns: Boolean

Attempts to parse comma- or semicolon-separated one-based page ranges.

Parameters

pageRanges System.String requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection@ requiredposition: 1

Properties

public IReadOnlyList<PdfPageRange> Ranges { get; } #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:19

Inclusive one-based ranges in caller order.

public Int32 PageCount { get; } #
OfficeIMO.Pdf/Manipulation/PdfPageSelection.cs:26

Total selected page count before operation-specific de-duplication.