API Reference
PdfPageInteractionMap
Dependency-free text-selection and hit-test projection for one rendered PDF page. Coordinates use the visual page's top-left origin after CropBox and page rotation are applied.
Inheritance
- Object
- PdfPageInteractionMap
Usage
Explore 4 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.
Returned or exposed by 4
Methods
public static PdfPageInteractionMap Create(Byte[] pdf, Int32 pageNumber, PdfPageInteractionOptions? options = null, PdfLoadOptions? readOptions = null) #PdfPageInteractionMapBuilds an interaction map from PDF bytes.
Parameters
- pdf System.Byte[]
- pageNumber System.Int32
- options OfficeIMO.Pdf.PdfPageInteractionOptions? = null
- readOptions OfficeIMO.Pdf.PdfLoadOptions? = null
public String GetSelectedText(Double x1, Double y1, Double x2, Double y2) #StringJoins selected text elements in extraction order, with a space across a gap between words and a line break between lines where the text does not already contain one.
Parameters
- x1 System.Double
- y1 System.Double
- x2 System.Double
- y2 System.Double
public static PdfTextBreak GetTextBreak(PdfPageInteractionRegion previous, PdfPageInteractionRegion next) #PdfTextBreakClassifies how next follows previous: touching, after a gap on the same line, or on another line. Words written as separate runs without space characters, such as an OCR text layer, are separated by gaps rather than by text.
Parameters
- previous OfficeIMO.Pdf.PdfPageInteractionRegion
- next OfficeIMO.Pdf.PdfPageInteractionRegion
public IReadOnlyList<PdfPageInteractionRegion> HitTest(Double x, Double y, Double tolerance = 0) #IReadOnlyList<PdfPageInteractionRegion>Returns all regions containing a visual top-left page coordinate.
Parameters
- x System.Double
- y System.Double
- tolerance System.Double = 0
public IReadOnlyList<PdfPageInteractionRegion> SelectText(Double x1, Double y1, Double x2, Double y2) #IReadOnlyList<PdfPageInteractionRegion>Returns text elements whose quads intersect a visual top-left selection rectangle.
Parameters
- x1 System.Double
- y1 System.Double
- x2 System.Double
- y2 System.Double
public IReadOnlyList<PdfPageInteractionRegion> SelectWord(Double x, Double y, Double tolerance = 0) #IReadOnlyList<PdfPageInteractionRegion>Selects the contiguous non-whitespace text run at a visual page coordinate, without crossing a line or a gap between independent runs.
Parameters
- x System.Double
- y System.Double
- tolerance System.Double = 0
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Double Width { get; } #Visual page width in PDF points after page rotation.
public Double Height { get; } #Visual page height in PDF points after page rotation.
public IReadOnlyList<PdfPageInteractionRegion> Regions { get; } #All text, image, link, annotation, and form-widget regions.
public IReadOnlyList<PdfPageInteractionRegion> TextRegions { get; } #Text-element regions in content extraction order.