API Reference
Class
OfficeDocumentSearchResult
Search results with aggregated page citation information.
Inheritance
- Object
- OfficeDocumentSearchResult
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
- Extension method OfficeDocumentReadResult.Search
- Method OfficeDocumentReadResultExtensions.Search
Inherited Methods
Properties
public OfficeDocumentSource Source { get; } #Source document that was searched.
public Int32 TotalPageCount { get; } #Total physical page count known for the read operation.
public IReadOnlyList<OfficeDocumentSearchHit> Hits { get; } #Matching occurrences in normalized source order.
public IReadOnlyList<Int32> PageNumbers { get; } #Distinct one-based physical pages containing matches.
public Boolean MaximumResultsReached { get; } #True when the configured maximum result count was reached and the search stopped at that ceiling.