Aspose::Pdf::Text::TextSearchOptions class
Contents
[
Hide
]TextSearchOptions class
Represents text search options.
class TextSearchOptions : public Aspose::Pdf::Text::TextOptions
Methods
| Method | Description |
|---|---|
| get_IgnoreResourceFontErrors() const | Gets indication that errors related to absence of font will be ignored by text (fragment) absorber. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false (default) - absence of font error will terminate processing by throwing exception. |
| get_IgnoreShadowText() const | Gets indication that text fragments representing shadow of normal text will be ignored during search. true - means that shadow text will not be found (try this if text search returns duplicated fragments on the close positions) false - means that shadow text will be found as well as normal text (default value) |
| get_IsRegularExpressionUsed() const | Gets indication that regular expression is used. |
| get_LimitToPageBounds() const | Gets indication that text is searched within the page bounds. |
| get_LogTextExtractionErrors() const | Gets indication that text extraction (decoding) errors will be logged in the text (fragment) absorber. true - means that text extraction (decoding) errors will be loged. It may decrease performance. false (default) - no error loging. |
| get_Rectangle() const | Gets rectangle that bounds the searched text. |
| get_SearchForTextRelatedGraphics() const | Gets value that permits searching for text related graphics (underlining, background etc.) during text search. true - searching for text related graphics will be performed (default value). false - graphic elements that may present in source document will be ignored. Set this in case of performance issues or no need to handle underlining, background, or clipping. |
| get_SearchInAnnotations() const | Gets value that permits searching for text in Annotations. true - text will be searched in Annotations. false - text in Annotations won’t be parsed by TextFragmentAbsorber. |
| get_StoredGraphicElementsMaxCount() const | Gets value that limits searching for text related graphics (underlining, background etc.) on a page for the speciefied number of elements. The default is 250. Set lesser value in the case of performance problems, try larger value in the case some graphic elements wasn’t found. |
| get_UseFontEngineEncoding() const | Gets indication that text will be searched using font engine encoding. true - means that font engine encoding will be used (try this if text search fails because of imperfect encoding in the document) false - means that document font encoding will be used (default value) |
| set_IgnoreResourceFontErrors(bool) | Sets indication that errors related to absence of font will be ignored by text (fragment) absorber. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false (default) - absence of font error will terminate processing by throwing exception. |
| set_IgnoreShadowText(bool) | Sets indication that text fragments representing shadow of normal text will be ignored during search. true - means that shadow text will not be found (try this if text search returns duplicated fragments on the close positions) false - means that shadow text will be found as well as normal text (default value) |
| set_IsRegularExpressionUsed(bool) | Sets indication that regular expression is used. |
| set_LimitToPageBounds(bool) | Sets indication that text is searched within the page bounds. |
| set_LogTextExtractionErrors(bool) | Sets indication that text extraction (decoding) errors will be logged in the text (fragment) absorber. true - means that text extraction (decoding) errors will be loged. It may decrease performance. false (default) - no error loging. |
| set_Rectangle(System::SharedPtr<Aspose::Pdf::Rectangle>) | Sets rectangle that bounds the searched text. |
| set_SearchForTextRelatedGraphics(bool) | Sets value that permits searching for text related graphics (underlining, background etc.) during text search. true - searching for text related graphics will be performed (default value). false - graphic elements that may present in source document will be ignored. Set this in case of performance issues or no need to handle underlining, background, or clipping. |
| set_SearchInAnnotations(bool) | Sets value that permits searching for text in Annotations. true - text will be searched in Annotations. false - text in Annotations won’t be parsed by TextFragmentAbsorber. |
| set_StoredGraphicElementsMaxCount(int32_t) | Sets value that limits searching for text related graphics (underlining, background etc.) on a page for the speciefied number of elements. The default is 250. Set lesser value in the case of performance problems, try larger value in the case some graphic elements wasn’t found. |
| set_UseFontEngineEncoding(bool) | Sets indication that text will be searched using font engine encoding. true - means that font engine encoding will be used (try this if text search fails because of imperfect encoding in the document) false - means that document font encoding will be used (default value) |
| TextSearchOptions(bool) | Initializes new instance of the TextSearchOptions object. Specifies regular expression usage mode. |
| TextSearchOptions(System::SharedPtr<Aspose::Pdf::Rectangle>) | Initializes new instance of the TextSearchOptions object. Specifies rectangle that delimits the searched text. |
| TextSearchOptions(System::SharedPtr<Aspose::Pdf::Rectangle>, bool) | Initializes new instance of the TextSearchOptions object. Specifies rectangle that delimits the searched text and regular expression usage mode. |
See Also
- Class TextOptions
- Namespace Aspose::Pdf::Text
- Library Aspose.PDF for C++