API Reference

Class

ReaderChunkDiagnostics

Namespace OfficeIMO.Reader
Assembly OfficeIMO.Reader
Modifiers sealed

Optional source diagnostics and structural counters attached to a reader chunk.

Inheritance

  • Object
  • ReaderChunkDiagnostics

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

Constructors

public ReaderChunkDiagnostics() #

Properties

public String SourceKind { get; set; } #

Source adapter that produced the diagnostics, for example "pdf".

public Int32 PageCount { get; set; } #

Total logical page count in the loaded source document.

public Int32 SelectedPageCount { get; set; } #

Number of pages selected for this read operation.

public Nullable<Int32> PageNumber { get; set; } #

One-based PDF page number for page-scoped chunks, when applicable.

public Int32 TableCount { get; set; } #

Number of logical tables in the selected scope.

public Int32 TableGeometryCount { get; set; } #

Number of logical tables in the selected scope that expose placement geometry.

public Double TableGeometryCoverage { get; set; } #

Ratio of tables with placement geometry to all tables in the selected scope.

public Nullable<Double> MinTableConfidence { get; set; } #

Lowest table detection confidence in the selected scope, when tables are present.

public Nullable<Double> AverageTableConfidence { get; set; } #

Average table detection confidence in the selected scope, when tables are present.

public Int32 ImageCount { get; set; } #

Number of logical images in the selected scope.

public Int32 ImageGeometryCount { get; set; } #

Number of logical images in the selected scope that expose placement geometry.

public Double ImageGeometryCoverage { get; set; } #

Ratio of images with placement geometry to all images in the selected scope.

public Int32 LinkCount { get; set; } #

Number of logical link annotations in the selected scope.

public Boolean HasOpenAction { get; set; } #

True when the source exposes a readable document open action.

public Boolean HasCatalogActions { get; set; } #

True when the source exposes active catalog-level actions.

public Boolean HasPageActions { get; set; } #

True when the selected chunk scope exposes page-level actions.

public Boolean HasAnnotationActions { get; set; } #

True when the selected chunk scope exposes annotation-level actions.

public Boolean HasActiveContent { get; set; } #

True when the source exposes active catalog, selected page, or selected annotation actions.

public Int32 CatalogActionCount { get; set; } #

Number of active catalog-level actions in the loaded source document.

public Int32 PageActionCount { get; set; } #

Number of page-level actions in the loaded source document.

public Int32 SelectedPageActionCount { get; set; } #

Number of page-level actions in this chunk's selected page scope.

public Int32 AnnotationActionCount { get; set; } #

Number of annotation-level actions in the loaded source document.

public Int32 SelectedAnnotationActionCount { get; set; } #

Number of annotation-level actions in this chunk's selected page scope.

public Int32 FormFieldCount { get; set; } #

Total form field count in the loaded source document.

public Int32 FormWidgetCount { get; set; } #

Total form widget count in the loaded source document.

public Int32 SelectedFormWidgetCount { get; set; } #

Number of form widgets in this chunk's selected page scope.

public Int32 SelectedFormWidgetAppearanceStateCount { get; set; } #

Number of selected form widgets that expose a current appearance state.

public Double SelectedFormWidgetAppearanceStateCoverage { get; set; } #

Ratio of selected form widgets with a current appearance state to all selected form widgets.

public Int32 SelectedFormWidgetNormalAppearanceStateCount { get; set; } #

Total readable normal appearance states across selected form widgets.

public Boolean HasSecurityState { get; set; } #

True when the source exposes encryption, signature, permission, or incremental-update markers.

public Boolean HasEncryption { get; set; } #

True when the source PDF contains an encryption marker.

public Boolean HasSignatures { get; set; } #

True when the source PDF contains signature markers, fields, or values.

public Boolean HasIncrementalUpdates { get; set; } #

True when the source PDF contains incremental-update markers.

public Int32 RevisionCount { get; set; } #

Number of readable PDF revision markers.

public Boolean RequiresAppendOnlyMutation { get; set; } #

True when mutation should preserve the existing PDF by appending a new revision.