API Reference
ReaderLocation
Generic location metadata used across supported formats.
Inheritance
- Object
- ReaderLocation
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
- Property OfficeDocumentAsset.Location
- Property OfficeDocumentBlock.Location
- Property OfficeDocumentDiagnostic.Location
- Property OfficeDocumentFormField.Location
- Property OfficeDocumentLink.Location
- Property OfficeDocumentMetadataEntry.Location
- Property OfficeDocumentOcrCandidate.Location
- Property OfficeDocumentPage.Location
- Property ReaderChunk.Location
- Property ReaderTable.Location
- Property ReaderVisual.Location
Constructors
public ReaderLocation() #Inherited Methods
Properties
public String Path { get; set; } #Source path used for citations.
public Nullable<Int32> BlockIndex { get; set; } #Optional emitted chunk index (0-based) in the order produced by DocumentReader.
public Nullable<Int32> 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 Nullable<Int32> StartLine { get; set; } #Optional 1-based source start line number when the reader can map it accurately.
public Nullable<Int32> EndLine { get; set; } #Optional 1-based source end line number when the reader can map it accurately.
public Nullable<Int32> NormalizedStartLine { get; set; } #Optional 1-based normalized markdown start line used for parser-aware markdown provenance.
public Nullable<Int32> 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 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 A1Range { get; set; } #Optional A1 range descriptor (Excel).
public Nullable<Int32> Slide { get; set; } #Optional 1-based slide number (PowerPoint).
public Nullable<Int32> Page { get; set; } #Optional 1-based page number (PDF).
public Nullable<Int32> TableIndex { get; set; } #Optional 0-based table index within the closest source container, such as a PDF page or spreadsheet sheet.