Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeTextIndexSearchResult

OfficeIMO.TextAnalysis

Namespace
OfficeIMO.TextAnalysis
Assembly
OfficeIMO.Core
Source revision
ac7e6e1bad8a with working tree changes
Modifiers
sealed

Ranked results of one query.

Inheritance

  • object
  • OfficeTextIndexSearchResult

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

Properties

public OfficeTextQuery? Query { get; } #

The evaluated query; null when the query text contained no clauses.

public bool HasSearchableText { get; } #

False when no clause had analysable text, for example a query of punctuation only. Callers can then fall back to literal matching.

public IReadOnlyList<OfficeTextIndexHit> Hits { get; } #

Hits by descending score, then by OfficeTextIndexHit.DocumentIndex.

public int TotalMatches { get; } #

Number of matching documents before OfficeTextIndexSearchOptions.MaximumResults applied.

public bool PrefixExpansionLimited { get; } #

True when a prefix matched more terms than OfficeTextIndexSearchOptions.MaximumPrefixExpansions.

public bool WorkLimitReached { get; } #

True when OfficeTextIndexSearchOptions.MaximumPostingsVisited stopped evaluation early.