SearchOptions
Contents
[
Hide
]
SearchOptions class
Provides the options which are used for text search.
public sealed class SearchOptions
Constructors
| Name | Description |
|---|---|
| SearchOptions() | Initializes a new instance of the SearchOptions class with default values. See remarks for details. |
| SearchOptions(bool, bool, bool) | Initializes a new instance of the SearchOptions class which is used to search without highlight extraction. |
| SearchOptions(bool, bool, bool, bool) | Initializes a new instance of the SearchOptions class which is used to search by pages and without highlight extraction. |
| SearchOptions(bool, bool, bool, HighlightOptions) | 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. |
| SearchOptions(bool, bool, bool, HighlightOptions, HighlightOptions) | 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. |
| SearchOptions(bool, bool, bool, bool, HighlightOptions, HighlightOptions) | Initializes a new instance of the SearchOptions class. |
| SearchOptions(bool, bool, bool, int, HighlightOptions, HighlightOptions) | Initializes a new instance of the SearchOptions class with the page limit. |
Properties
| Name | Description |
|---|---|
| LeftHighlightOptions { get; set; } | Gets the options for the left highlight. |
| MatchCase { get; set; } | Gets the value that indicates whether a text case isn’t ignored. |
| MatchWholeWord { get; set; } | Gets the value that indicates whether text search is limited by a whole word. |
| MaxPageIndex { get; set; } | Gets the value that represents the max index of the page to search. |
| RightHighlightOptions { get; set; } | Gets the options for the right highlight. |
| SearchByPages { get; set; } | Gets the value that indicates whether the search is performed by pages. |
| UseRegularExpression { get; set; } | Gets the value that indicates whether a regular expression is used. |
Remarks
An instance of SearchOptions class is used as parameter in Search method. See the usage examples there.
Learn more:
- Search text
- Search text in Microsoft Office Word documents
- Search text in Microsoft Office Excel spreadsheets
- Search text in Microsoft Office PowerPoint presentations
- Search text in PDF documents
- Search text in Emails
- Search text in EPUB eBooks
- Search text in HTML documents
- Search text in Microsoft OneNote sections
See Also
- namespace GroupDocs.Parser.Options
- assembly GroupDocs.Parser
