Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 575 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

ExcelDocumentReaderExtensions

Edit on GitHub
Namespace OfficeIMO.Reader.Excel
Assembly OfficeIMO.Reader.Excel
Source revision a0f47aa4f111 with working tree changes
Source ExcelDocumentReaderExtensions.cs:16
Modifiers static

Projects caller-owned Excel models through the canonical Reader adapter.

Inheritance

  • Object
  • ExcelDocumentReaderExtensions

Methods

public static OfficeDocumentReadResult ReadDocument(ExcelDocument document, String? sourceName = null, ReaderOptions? options = null, ReaderExcelOptions? formatOptions = null, CancellationToken cancellationToken = default) #
ExcelDocumentReaderExtensions.cs:16
Returns: OfficeDocumentReadResult

Reads table text, structures and requested inspection evidence from an already loaded workbook.

Parameters

document OfficeIMO.Excel.ExcelDocument requiredposition: 0
Caller-owned model, which remains open after projection.
sourceName System.String? = null optionalposition: 1
Logical citation name; omitted names use workbook.xlsx. No source file is reopened.
options OfficeIMO.Reader.ReaderOptions? = null optionalposition: 2
Snapshotted projection and output budgets. The default projection is Full.
formatOptions OfficeIMO.Reader.Excel.ReaderExcelOptions? = null optionalposition: 3
Snapshotted Excel projection policy, including its native read options.
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
Cancellation for this projection.