Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfPageSelection

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Implements
IEquatable<PdfPageSelection>
Modifiers sealed

Represents caller-ordered one-based PDF page selections.

Inheritance

  • Object
  • PdfPageSelection

Usage

Explore 54 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.

Accepted by parameters 46

Methods

Equals 2 overloads
public Boolean Equals(PdfPageSelection? other) #
Returns: Boolean

Indicates whether the current object is equal to another object of the same type.

Parameters

other OfficeIMO.Pdf.PdfPageSelection? requiredposition: 0
An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

public override Boolean Equals(Object? obj) #
Returns: Boolean

Determines whether the specified object is equal to the current object.

Parameters

obj System.Object? requiredposition: 0
The object to compare with the current object.

Returns

true if the specified object is equal to the current object; otherwise, false.

From 2 overloads
public static PdfPageSelection From(params Int32[] pageNumbers) #
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) #
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) #
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() #
Returns: Int32

Serves as the default hash function.

Returns

A hash code for the current object.

public static PdfPageSelection Parse(String pageRanges) #
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 IReadOnlyList<Int32> Resolve(Int32 pageCount) #
Returns: IReadOnlyList<Int32>

Resolves this selection against a document page count, preserving caller order and repeated pages.

Parameters

pageCount System.Int32 requiredposition: 0
public override String ToString() #
Returns: String

Returns a string that represents the current object.

Returns

A string that represents the current object.

public static Boolean TryParse(String? pageRanges, out PdfPageSelection? selection) #
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; } #

Inclusive one-based ranges in caller order.

public Int32 PageCount { get; } #

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