Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeTextIndexSearchOptions

OfficeIMO.TextAnalysis

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

Per-query limits and output settings for OfficeTextIndex searches.

Inheritance

  • object
  • OfficeTextIndexSearchOptions

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.

Accepted by parameters 1

Constructors

public OfficeTextIndexSearchOptions() #

Properties

public OfficeTextQueryOperator DefaultOperator { get; set; } #

Operator between adjacent clauses when query text is parsed. Default: OfficeTextQueryOperator.And.

public int MaximumResults { get; set; } #

Maximum number of ranked hits returned. Default: 100.

public int MaximumClauses { get; set; } #

Maximum term, phrase and prefix clauses in one query. Default: 64.

public int MaximumPrefixExpansions { get; set; } #

Maximum index terms one prefix expands to. Terms are taken in ordinal order; the result reports when a prefix had more. Default: 128.

public long MaximumPostingsVisited { get; set; } #

Maximum postings read while evaluating the query. When reached, evaluation stops and the result reports it; hits found so far are still ranked. Default: 10,000,000.

public bool IncludeHighlights { get; set; } #

When true (the default), each hit lists the matched source ranges per field.