1. GroupDocs.Parser
  2. /
  3. GroupDocs.Parser for Python via .NET
  4. /
  5. groupdocs.parser.options
  6. /
  7. SearchOptions class

SearchOptions class

On this page

SearchOptions class

Provides the options which are used for text search.

The SearchOptions type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the SearchOptions class.
init Initializes a new instance of the SearchOptions class with the page limit.
init Initializes a new instance of the SearchOptions class which is used to search
with the highlight options for the left and the right highlight extraction.
init Initializes a new instance of the SearchOptions class which is used to search
with the same highlight options for the left and the right highlight extraction.
init Initializes a new instance of the SearchOptions class which is used to search
without highlight extraction.
init Initializes a new instance of the SearchOptions class which is used to search by pages and
without highlight extraction.
init Initializes a new instance of the SearchOptions class with default values. See remarks for details.

Properties

Property Description
match_case Gets the value that indicates whether a text case isn’t ignored.
match_whole_word Gets the value that indicates whether text search is limited by a whole word.
use_regular_expression Gets the value that indicates whether a regular expression is used.
search_by_pages Gets the value that indicates whether the search is performed by pages.
max_page_index Gets the value that represents the max index of the page to search.
left_highlight_options Gets the options for the left highlight.
right_highlight_options Gets the options for the right highlight.

Remarks

An instance of SearchOptions class is used as parameter in Parser.search method. See the usage examples there.

See Also

On this page