Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ReaderChunkDiagnostics

OfficeIMO.Reader

Namespace
OfficeIMO.Reader
Assembly
OfficeIMO.Reader.Core
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

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

Inheritance

  • object
  • ReaderChunkDiagnostics

Usage

Explore 1 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 1

Constructors

public ReaderChunkDiagnostics() #

Properties

public string SourceKind { get; set; } #

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

public int PageCount { get; set; } #

Total logical page count in the loaded source document.

public int SelectedPageCount { get; set; } #

Number of pages selected for this read operation.

public int? PageNumber { get; set; } #

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

public int TableCount { get; set; } #

Number of logical tables in the selected scope.

public int 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 double? MinTableConfidence { get; set; } #

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

public double? AverageTableConfidence { get; set; } #

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

public int LowConfidenceTableCount { get; set; } #

Number of logical tables whose confidence is below the reader's high-confidence threshold.

public int NumericTableColumnCount { get; set; } #

Number of numeric-looking table columns in the selected scope.

public int UnnamedTableColumnCount { get; set; } #

Number of table columns whose names could not be established from source structure.

public int MissingTableCellCount { get; set; } #

Number of expected table cells that were empty or unavailable in the selected scope.

public int ImageCount { get; set; } #

Number of logical images in the selected scope.

public int 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 int ImageNonAxisAlignedCount { get; set; } #

Number of logical images in the selected scope whose primary placement is not axis-aligned.

public double ImageNonAxisAlignedCoverage { get; set; } #

Ratio of non-axis-aligned image placements to all images with placement geometry in the selected scope.

public int LinkCount { get; set; } #

Number of logical link annotations in the selected scope.

public bool HasXmpMetadata { get; set; } #

True when the source exposes readable XMP metadata.

public int OutputIntentCount { get; set; } #

Number of readable output intents in the source document catalog.

public int AttachmentCount { get; set; } #

Number of readable embedded or associated file attachments in the source document.

public bool HasTaggedContent { get; set; } #

True when the source exposes tagged PDF structure metadata.

public int TaggedStructureElementCount { get; set; } #

Number of readable tagged PDF structure elements in the source document.

public int TaggedMarkedContentReferenceCount { get; set; } #

Number of readable tagged PDF marked-content references in the source document.

public int OptionalContentGroupCount { get; set; } #

Number of readable optional-content groups/layers in the source document catalog.

public int OptionalContentInitiallyHiddenCount { get; set; } #

Number of optional-content groups/layers initially hidden by the default configuration.

public int OptionalContentLockedCount { get; set; } #

Number of optional-content groups/layers locked by the default configuration.

public bool HasOpenAction { get; set; } #

True when the source exposes a readable document open action.

public bool HasCatalogActions { get; set; } #

True when the source exposes active catalog-level actions.

public bool HasPageActions { get; set; } #

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

public bool HasAnnotationActions { get; set; } #

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

public bool HasActiveContent { get; set; } #

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

public int PotentiallyUnsafeActionCount { get; set; } #

Number of selected actions whose type can execute script, launch external content, submit/import data, or play rich media.

public int JavaScriptActionCount { get; set; } #

Number of selected JavaScript actions.

public int LaunchActionCount { get; set; } #

Number of selected launch actions.

public int SubmitFormActionCount { get; set; } #

Number of selected form submission actions.

public int ImportDataActionCount { get; set; } #

Number of selected import-data actions.

public int CatalogActionCount { get; set; } #

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

public int PageActionCount { get; set; } #

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

public int SelectedPageActionCount { get; set; } #

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

public int AnnotationActionCount { get; set; } #

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

public int SelectedAnnotationActionCount { get; set; } #

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

public int FormFieldCount { get; set; } #

Total form field count in the loaded source document.

public int FormWidgetCount { get; set; } #

Total form widget count in the loaded source document.

public int SelectedFormWidgetCount { get; set; } #

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

public int 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 int SelectedFormWidgetNormalAppearanceStateCount { get; set; } #

Total readable normal appearance states across selected form widgets.

public bool HasSecurityState { get; set; } #

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

public bool HasEncryption { get; set; } #

True when the source PDF contains an encryption marker.

public bool HasSignatures { get; set; } #

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

public bool HasIncrementalUpdates { get; set; } #

True when the source PDF contains incremental-update markers.

public int RevisionCount { get; set; } #

Number of readable PDF revision markers.

public bool RequiresAppendOnlyMutation { get; set; } #

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