Get Started

API Reference

Struct

PdfPageRange

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:15
Base ValueType
Implements
IEquatable<PdfPageRange>
Modifiers sealed

Represents an inclusive one-based PDF page range.

Inheritance

  • ValueType
  • PdfPageRange

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

Constructors

public PdfPageRange(Int32 firstPage, Int32 lastPage) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:15

Creates an inclusive one-based PDF page range.

Parameters

firstPage System.Int32 requiredposition: 0
lastPage System.Int32 requiredposition: 1

Methods

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

Parameters

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

Parameters

obj System.Object requiredposition: 0
public static PdfPageRange From(Int32 firstPage, Int32 lastPage) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:46
Returns: PdfPageRange

Creates an inclusive one-based PDF page range.

Parameters

firstPage System.Int32 requiredposition: 0
lastPage System.Int32 requiredposition: 1
public override Int32 GetHashCode() #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:201
Returns: Int32
public static Boolean op_Equality(PdfPageRange left, PdfPageRange right) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:178
Returns: Boolean

Compares two page ranges for equality.

Parameters

left OfficeIMO.Pdf.PdfPageRange requiredposition: 0
right OfficeIMO.Pdf.PdfPageRange requiredposition: 1
public static Boolean op_Inequality(PdfPageRange left, PdfPageRange right) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:185
Returns: Boolean

Compares two page ranges for inequality.

Parameters

left OfficeIMO.Pdf.PdfPageRange requiredposition: 0
right OfficeIMO.Pdf.PdfPageRange requiredposition: 1
public static PdfPageRange Parse(String pageRange) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:53
Returns: PdfPageRange

Parses one inclusive one-based page range from text such as 3, 1-3, or 1..3.

Parameters

pageRange System.String requiredposition: 0
public static PdfPageRange[] ParseMany(String pageRanges) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:93
Returns: PdfPageRange[]

Parses comma- or semicolon-separated inclusive one-based page ranges, preserving caller order.

Parameters

pageRanges System.String requiredposition: 0
public override String ToString() #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:207
Returns: String
public static Boolean TryParse(String pageRange, out PdfPageRange range) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:67
Returns: Boolean

Attempts to parse one inclusive one-based page range from text such as 3, 1-3, or 1..3.

Parameters

pageRange System.String requiredposition: 0
range OfficeIMO.Pdf.PdfPageRange@ requiredposition: 1
public static Boolean TryParseMany(String pageRanges, out PdfPageRange[] ranges) #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:118
Returns: Boolean

Attempts to parse comma- or semicolon-separated inclusive one-based page ranges, preserving caller order.

Parameters

pageRanges System.String requiredposition: 0
ranges OfficeIMO.Pdf.PdfPageRange[]@ requiredposition: 1

Properties

public Int32 FirstPage { get; } #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:30

First page in the inclusive one-based range.

public Int32 LastPage { get; } #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:35

Last page in the inclusive one-based range.

public Int32 PageCount { get; } #
OfficeIMO.Pdf/Manipulation/PdfPageRange.cs:40

Number of pages in the range.