Struct PdfPageTextSegment

pub struct PdfPageTextSegment<'a> { /* private fields */ }

A single rectangular text segment in a PdfPageTextSegments collection.

Pdfium automatically merges smaller text boxes into larger text segments if all enclosed characters share the same baseline and the same font settings. The number of individual PdfPageTextObject objects on the page may be much larger than the number of text segments.

Implementations

impl<'a> PdfPageTextSegment<'a>

pub fn bounds(&self) -> PdfRect

Returns the bounding box of this PdfPageTextSegment.

pub fn width(&self) -> PdfPoints

Returns the width of this PdfPageTextSegment.

pub fn height(&self) -> PdfPoints

Returns the height of this PdfPageTextSegment.

pub fn is_inside_rect(&self, rect: &PdfRect) -> bool

Returns true if the bounds of this PdfPageTextSegment lie entirely within the given rectangle.

pub fn does_overlap_rect(&self, rect: &PdfRect) -> bool

Returns true if the bounds of this PdfPageTextSegment lie at least partially within the given rectangle.

pub fn text(&self) -> String

Returns all characters that lie within the bounds of this PdfPageTextSegment in the containing PdfPage, in the order in which they are defined in the document.

In complex custom layouts, the order in which characters are defined in the document and the order in which they appear visually during rendering (and thus the order in which they are read by a user) may not necessarily match.

pub fn chars(&self) -> Result<PdfPageTextChars<'_>, PdfiumError>

Returns a collection of all the PdfPageTextChar characters that lie within the bounds of this PdfPageTextSegment in the containing PdfPage, in the order in which they are defined in the document.

In complex custom layouts, the order in which characters are defined in the document and the order in which they appear visually during rendering (and thus the order in which they are read by a user) may not necessarily match.