API Reference
PdfPageSelector
Represents a document-relative, caller-ordered page selection expression.
Inheritance
- Object
- PdfPageSelector
Remarks
Selectors are resolved against a document page count. Supported terms include absolute pages and ranges (1, 1-3, 5..2), end-relative pages (last, last-2), all, odd, even, and exclusions prefixed with !.
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
- Property PdfBatesDocument.TargetPages
- Property PdfBatesNumberingOptions.TargetPages
- Property PdfCanvasStampOptions.TargetPages
- Property PdfInterleaveSource.Pages
- Property PdfPageOverlayOptions.TargetPages
- Method PdfPageSelector.Parse
- Property PdfWatermarkOptions.TargetPages
Accepted by parameters
- Method PdfDocumentImageEditor.Extract
- Method PdfDocumentImageEditor.Placements
- Method PdfDocumentPages.Delete
- Method PdfDocumentPages.DeleteResult
- Method PdfDocumentPages.Duplicate
- Method PdfDocumentPages.DuplicateResult
- Method PdfDocumentPages.Extract
- Method PdfDocumentPages.ExtractResult
- Method PdfDocumentPages.Move
- Method PdfDocumentPages.MoveResult
- Method PdfDocumentPages.Reorder
- Method PdfDocumentPages.ReorderResult
- Method PdfDocumentPages.Rotate
- Method PdfDocumentPages.RotateResult
- Method PdfDocumentResources.Fonts
- Method PdfPageSelector.Equals
- Method PdfPageSelector.TryParse
Methods
public Boolean Equals(PdfPageSelector other) #BooleanIndicates whether the current object is equal to another object of the same type.
Parameters
- other OfficeIMO.Pdf.PdfPageSelector
- 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) #BooleanDetermines whether the specified object is equal to the current object.
Parameters
- obj System.Object
- The object to compare with the current object.
Returns
true if the specified object is equal to the current object; otherwise, false.
public override Int32 GetHashCode() #Int32Serves as the default hash function.
Returns
A hash code for the current object.
public static PdfPageSelector Parse(String expression) #PdfPageSelectorParses a document-relative page selector.
Parameters
- expression System.String
public IReadOnlyList<Int32> Resolve(Int32 pageCount) #IReadOnlyList<Int32>Resolves the selector to caller-ordered, one-based page numbers.
Parameters
- pageCount System.Int32
public PdfPageSelection ResolveSelection(Int32 pageCount) #PdfPageSelectionResolves the selector to an absolute page selection.
Parameters
- pageCount System.Int32
public override String ToString() #StringReturns a string that represents the current object.
Returns
A string that represents the current object.
public static Boolean TryParse(String expression, out PdfPageSelector selector) #BooleanAttempts to parse a document-relative page selector.
Parameters
- expression System.String
- selector OfficeIMO.Pdf.PdfPageSelector@
Inherited Methods
Properties
public String Expression { get; } #Original normalized selector expression.