API Reference
PdfUnderstandingWord
One decoded word candidate with source-run traceability.
Inheritance
- Object
- PdfUnderstandingWord
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
- Method IPdfWordGroupingStage.GroupWords
- Property PdfUnderstandingLine.Words
- Property PdfUnderstandingPageResult.Words
Accepted by parameters
- Method IPdfLineGroupingStage.GroupLines
- Constructor PdfUnderstandingLine.PdfUnderstandingLine
Constructors
public PdfUnderstandingWord(String text, Double xStart, Double xEnd, Double baselineY, Double fontSize, Double rotationDegrees, IReadOnlyList<PdfTextSpan> sourceRuns, Double confidence = 1, IEnumerable<PdfInferenceEvidence> evidence = null, Nullable<Double> advance = null, PdfLogicalVisualBounds visualBounds = null, Nullable<Int32> sourceSequence = null) #Creates a positioned word artifact for a custom grouping stage.
Parameters
- text System.String
- xStart System.Double
- xEnd System.Double
- baselineY System.Double
- fontSize System.Double
- rotationDegrees System.Double
- sourceRuns System.Collections.Generic.IReadOnlyList{OfficeIMO.Pdf.PdfTextSpan}
- confidence System.Double = 1
- evidence System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfInferenceEvidence} = null
- advance System.Nullable{System.Double} = null
- visualBounds OfficeIMO.Pdf.PdfLogicalVisualBounds = null
- sourceSequence System.Nullable{System.Int32} = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Text { get; } #Decoded word text.
public Double XStart { get; } #Left bound in PDF points.
public Double XEnd { get; } #Right bound in PDF points.
public Double BaselineY { get; } #Baseline Y in PDF points.
public Double FontSize { get; } #Representative font size.
public Double RotationDegrees { get; } #Baseline rotation in degrees.
public Nullable<Double> Advance { get; } #Distance occupied along the baseline, including vertical and rotated baselines, when known.
public PdfLogicalVisualBounds VisualBounds { get; } #Direct top-left visual bounds, when supplied by a positioned source such as OCR.
public Nullable<Int32> SourceSequence { get; } #Original zero-based source order, when supplied by the decoder or positioned provider.
public IReadOnlyList<PdfTextSpan> SourceRuns { get; } #Decoded source runs that produced this word.
public Double Confidence { get; } #Normalized grouping confidence from 0 to 1.
public IReadOnlyList<PdfInferenceEvidence> Evidence { get; } #Evidence supporting this word grouping.