TextFragmentAbsorber

TextFragmentAbsorber class

Represents an absorber object of text fragments.
Performs text search and provides access to search results via text_fragments collection.

The TextFragmentAbsorber type exposes the following members:

Constructors

NameDescription
TextFragmentAbsorber()Initializes a new instance of the TextFragmentAbsorber that performs search of all text segments of the document or page.
TextFragmentAbsorber(text_edit_options)Initializes a new instance of the TextFragmentAbsorber class
TextFragmentAbsorber(phrase)Initializes a new instance of the TextFragmentAbsorber class
TextFragmentAbsorber(phrase, text_search_options)Initializes a new instance of the TextFragmentAbsorber class
TextFragmentAbsorber(phrase, text_search_options, text_edit_options)Initializes a new instance of the TextFragmentAbsorber class
TextFragmentAbsorber(phrase, text_edit_options)Initializes a new instance of the TextFragmentAbsorber class

Properties

NameDescription
textGets extracted text that the TextAbsorber extracts on the PDF document or page.
has_errorsValue indicates whether errors were found during text extraction.
Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance.
errorsList of TextExtractionError objects. It contain information about errors were found during text extraction.
Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance.
extraction_optionsGets or sets text extraction options.
text_search_optionsGets or sets search options. The options enable search using regular expressions.
text_fragmentsGets collection of search occurrences that are presented with TextFragment objects.
phraseGets or sets phrase that the TextFragmentAbsorber searches on the PDF document or page.
text_edit_optionsGets or sets text edit options. The options define special behavior when requested symbol cannot be written with font.
text_replace_optionsGets or sets text replace options. The options define behavior when fragment text is replaced to more short/long.

Methods

NameDescription
visit(page)Performs search on the specified page.
visit(pdf)Performs search on the specified document.
visit(x_form)Performs search on the specified form object.
apply_for_all_fragments(font)Applies font for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping.
apply_for_all_fragments(font_size)Applies font size for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping.
apply_for_all_fragments(font, font_size)Applies font and size for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping.
remove_all_text(page)Removes all text from the specified page.
remove_all_text(page, rect)Removes text inside the specified rectangle from the specified page.
remove_all_text(document)Removes all text from the document.
reset()Clears TextFragments collection of this TextFragmentAbsorber object.

See Also