Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ReaderLocation

OfficeIMO.Reader

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

Generic location metadata used across supported formats.

Inheritance

  • object
  • ReaderLocation

Usage

Explore 16 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.

Accepted by parameters 1

Constructors

public ReaderLocation() #

Properties

public long? LogicalOrder { get; set; } #
JsonIgnore(Condition = 3)

Explicit native reading-order position across physical containers. Null retains canonical container order.

public string? Path { get; set; } #

Source path used for citations.

public int? BlockIndex { get; set; } #

Optional emitted chunk index (0-based) in the order produced by OfficeDocumentReader.

public int? SourceBlockIndex { get; set; } #

Optional source block index within the input document (producer-defined). For Word, this is the first block index included in the emitted chunk.

public int? StartLine { get; set; } #

Optional 1-based source start line number when the reader can map it accurately.

public int? EndLine { get; set; } #

Optional 1-based source end line number when the reader can map it accurately.

public int? NormalizedStartLine { get; set; } #

Optional 1-based normalized markdown start line used for parser-aware markdown provenance.

public int? NormalizedEndLine { get; set; } #

Optional 1-based normalized markdown end line used for parser-aware markdown provenance.

public string? HeadingPath { get; set; } #

Optional heading path label (for example "H1 > H2").

public string? HierarchyHeadingPath { get; set; } #

Escaped heading path used by hierarchy projections. Normal Reader output keeps ReaderLocation.HeadingPath as the original display value. This value is transported so a serialized read result can reproduce the same hierarchy as the in-memory result.

public string? HeadingSlug { get; set; } #

Optional unique slug/anchor for the active heading section.

public string? SourceBlockKind { get; set; } #

Optional source block kind label (for example "heading", "paragraph", "code").

public string? BlockAnchor { get; set; } #

Optional deterministic anchor for the first logical block included in the chunk. For markdown this can identify a heading section or a sub-block within that section.

public string? Sheet { get; set; } #

Optional sheet name (Excel).

public string? A1Range { get; set; } #

Optional source cell or range descriptor in A1 notation. For containers with multiple tables, ReaderLocation.TableIndex identifies the table whose coordinates are used.

public int? Slide { get; set; } #

Optional 1-based slide number (PowerPoint).

public int? Page { get; set; } #

Optional 1-based page number (PDF).

public int? TableIndex { get; set; } #

Optional 0-based table index within the closest source container, such as a PDF page or spreadsheet sheet.