API Reference
Class
PdfUnderstandingImageRegion
One positioned image region with an optional associated caption.
Inheritance
- Object
- PdfUnderstandingImageRegion
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 IPdfImageRegionDetectionStage.Detect
- Property PdfLogicalImage.PrimaryRegion
- Property PdfLogicalImage.Regions
- Property PdfUnderstandingPageResult.ImageRegions
Constructors
public PdfUnderstandingImageRegion(PdfImagePlacement placement, PdfUnderstandingSemanticElement caption = null, Double confidence = 0.5, IEnumerable<PdfInferenceEvidence> evidence = null, Boolean isFigure = false, String alternativeText = null) #Creates an image region for a custom detection stage.
Parameters
- placement OfficeIMO.Pdf.PdfImagePlacement
- caption OfficeIMO.Pdf.PdfUnderstandingSemanticElement = null
- confidence System.Double = 0.5
- evidence System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfInferenceEvidence} = null
- isFigure System.Boolean = false
- alternativeText System.String = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public PdfImagePlacement Placement { get; } #Source image placement represented by this region.
public PdfUnderstandingSemanticElement Caption { get; } #Caption associated by structural or geometric evidence, when available.
public Boolean IsFigure { get; } #True when a caption association or tagged-PDF Figure role establishes a figure.
public String AlternativeText { get; } #Tagged-PDF alternate text for the figure, when present.
public Double Confidence { get; } #Normalized image-region and association confidence from 0 to 1.
public IReadOnlyList<PdfInferenceEvidence> Evidence { get; } #Stable evidence supporting the image region and optional caption association.