public final class TextFragmentAbsorber extends TextAbsorber
Represents an absorber object of text fragments.
Performs text search and provides access to search results via TextFragmentAbsorber.TextFragments
collection.
The example demonstrates how to find text on the first PDF document page and replace the text and it's font.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Find font that will be used to change document text font com.aspose.pdf.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.getPages().get(1).accept(absorber); // Change text and font of the first text occurrence absorber.getTextFragments().get_Item(1).setText ( "hi world"); absorber.getTextFragments().get_Item(1).getTextState().setFont ( font); // Save document doc.save("D:\Tests\output.pdf");
TextFragmentAbsorber
object is basically used in text search scenario.
When the search is completed the occurrences are represented with TextFragment
objects that the TextFragmentAbsorber.TextFragments
collection contains.
The TextFragment
object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc).
Constructor and Description |
---|
TextFragmentAbsorber()
Initializes a new instance of the
TextFragmentAbsorber that performs search of all text segments of the document or page. |
TextFragmentAbsorber(String phrase)
Initializes a new instance of the
TextFragmentAbsorber class for the specified text phrase. |
TextFragmentAbsorber(String phrase,
TextEditOptions textEditOptions)
Initializes a new instance of the
TextFragmentAbsorber class for the specified text phrase and text edit options. |
TextFragmentAbsorber(String phrase,
TextSearchOptions textSearchOptions)
Initializes a new instance of the
TextFragmentAbsorber class for the specified text phrase and text search options. |
TextFragmentAbsorber(String phrase,
TextSearchOptions textSearchOptions,
TextEditOptions textEditOptions)
Initializes a new instance of the
TextFragmentAbsorber class for the specified text phrase, text search options and text edit options. |
TextFragmentAbsorber(TextEditOptions textEditOptions)
Initializes a new instance of the
TextFragmentAbsorber with text edit options, that performs search of all text segments of the document or page. |
Modifier and Type | Method and Description |
---|---|
TextExtractionOptions |
getExtractionOptions()
Gets or sets text extraction options.
|
String |
getPhrase()
Gets phrase that the
TextFragmentAbsorber searches on the PDF document or page. |
TextEditOptions |
getTextEditOptions()
Gets text edit options.
|
TextFragmentCollection |
getTextFragments()
Gets collection of search occurrences that are presented with
TextFragment objects. |
TextSearchOptions |
getTextSearchOptions()
Gets search options.
|
void |
setExtractionOptions(TextExtractionOptions value) |
void |
setPhrase(String value)
Gets phrase that the
TextFragmentAbsorber searches on the PDF document or page. |
void |
setTextEditOptions(TextEditOptions value)
Sets text edit options.
|
void |
setTextFragments(TextFragmentCollection value)
Sets collection of search occurrences that are presented with
TextFragment objects. |
void |
setTextSearchOptions(TextSearchOptions value)
Sets search options.
|
void |
visit(IDocument pdf)
Performs search on the specified document.
|
void |
visit(Page page)
Performs search on the specified page.
|
void |
visit(XForm xForm)
Performs search on the specified form object.
|
getText
public TextFragmentAbsorber()
Initializes a new instance of the TextFragmentAbsorber
that performs search of all text segments of the document or page.
The example demonstrates how to find text on the first PDF document page and replace the text.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Find font that will be used to change document text font Font font = FontRepository.findFont("Arial"); // Create TextFragmentAbsorber object TextFragmentAbsorber absorber = new TextFragmentAbsorber(); // Make the absorber to search all "hello world" text occurrences absorber.setPhrase ( "hello world"); // Accept the absorber for first page doc.getPages().get(1).accept(absorber); // Change text of the first text occurrence absorber.getTextFragments().get_Item(1).setText ( "hi world"); // Save document doc.save("D:\Tests\output.pdf");
TextFragmentAbsorber.TextFragments
collection.
public TextFragmentAbsorber(TextEditOptions textEditOptions)
Initializes a new instance of the TextFragmentAbsorber
with text edit options, that performs search of all text segments of the document or page.
The example demonstrates how to find all text fragments on the first PDF document page and replace font for them.// Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object TextFragmentAbsorber absorber = new TextFragmentAbsorber(new TextEditOptions(TextEditOptions.FontReplace.RemoveUnusedFonts)); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Find Courier font Pdf.Text.Font font = FontRepository.FindFont("Courier"); // Set the font for all the text fragments foreach (TextFragment textFragment in absorber.TextFragments) { textFragment.TextState.Font = font; } // Save document doc.Save(@"D:\Tests\output.pdf");
textEditOptions
- Text edit options (Allows to turn on some edit features).
TextFragmentAbsorber.TextFragments
collection.
public TextFragmentAbsorber(String phrase)
Initializes a new instance of the TextFragmentAbsorber
class for the specified text phrase.
The example demonstrates how to find text on the first PDF document page and replace the text and it's font.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Find font that will be used to change document text font com.aspose.pdf.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.getPages().get(1).accept(absorber); // Change text and font of the first text occurrence absorber.getTextFragments().get_Item(1).setText ( "hi world"); absorber.getTextFragments().get_Item(1).getTextState().setFont ( font); // Save document doc.save("D:\Tests\output.pdf");
phrase
- Phrase that the TextFragmentAbsorber
searches
TextFragmentAbsorber.TextFragments
collection.
public TextFragmentAbsorber(String phrase, TextSearchOptions textSearchOptions)
Initializes a new instance of the TextFragmentAbsorber
class for the specified text phrase and text search options.
The example demonstrates how to find text with regular expression on the first PDF document page and replace the text.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Create TextFragmentAbsorber object that seatches all words starting 'h' and ending 'o' using regular expression. TextFragmentAbsorber absorber = new TextFragmentAbsorber("h\w*?o", new TextSearchOptions(true)); // we should find "hello" word and replace it with "Hi" doc.getPages().get(1).accept(absorber); absorber.getTextFragments().get_Item(1).setText ( "Hi"); // Save document doc.save("D:\Tests\output.pdf");
phrase
- Phrase that the TextFragmentAbsorber
searchestextSearchOptions
- Text search options (Allows to turn on some search features. For example, search with regular expression)
TextFragmentAbsorber.TextFragments
collection.
public TextFragmentAbsorber(String phrase, TextSearchOptions textSearchOptions, TextEditOptions textEditOptions)
Initializes a new instance of the TextFragmentAbsorber
class for the specified text phrase, text search options and text edit options.
The text edit options are not supported yet.
The example demonstrates how to find text with regular expression on the first PDF document page and replace the text.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Create TextFragmentAbsorber object that seatches all words starting 'h' and ending 'o' using regular expression. TextFragmentAbsorber absorber = new TextFragmentAbsorber("h\w*?o", new TextSearchOptions(true)); // we should find "hello" word and replace it with "Hi" doc.getPages().get(1).accept(absorber); absorber.getTextFragments().get_Item(1).setText ( "Hi"); // Save document doc.save("D:\Tests\output.pdf");
phrase
- Phrase that the TextFragmentAbsorber
searchestextSearchOptions
- Text search options (Allows to turn on some search features. For example, search with regular expression)textEditOptions
- Text edit options (Allows to turn on some edit features. For example, define special behavior when requested symbol cannot be written with font). The parameter is not supported yet.
TextFragmentAbsorber.TextFragments
collection.
public TextFragmentAbsorber(String phrase, TextEditOptions textEditOptions)
Initializes a new instance of the TextFragmentAbsorber
class for the specified text phrase and text edit options.
phrase
- Phrase that the TextFragmentAbsorber
searchestextEditOptions
- Text edit options (Allows to turn on some edit features).
TextFragmentAbsorber.TextFragments
collection.
public TextFragmentCollection getTextFragments()
Gets collection of search occurrences that are presented with TextFragment
objects.
The example demonstrates how to find text on the first PDF document page and replace all search occurrences with new text.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Find font that will be used to change document text font Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.getPages().get(1).accept(absorber); // Change text of all search occurrences for (TextFragment textFragment : absorber.getTextFragments()) { textFragment.setText ( "hi world"); } // Save document doc.save("D:\Tests\output.pdf");
public void setTextFragments(TextFragmentCollection value)
Sets collection of search occurrences that are presented with TextFragment
objects.
public String getPhrase()
Gets phrase that the TextFragmentAbsorber
searches on the PDF document or page.
The example demonstrates how to perform search text several times and perform text replacements.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello"); doc.getPages().get(1).accept(absorber); absorber.getTextFragments().get_Item(1).setText ( "Hi"); // search another word and replace it absorber.setPhrase ( "world"); doc.getPages().get(1).accept(absorber); absorber.getTextFragments().get_Item(1).setText ( "John"); // Save document doc.save("D:\Tests\output.pdf");
public void setPhrase(String value)
Gets phrase that the TextFragmentAbsorber
searches on the PDF document or page.
public TextSearchOptions getTextSearchOptions()
Gets search options. The options enable search using regular expressions.
The example demonstrates how to perform search text using regular expression.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Create TextFragmentAbsorber object TextFragmentAbsorber absorber = new TextFragmentAbsorber(); // make the absorber to search all words starting 'h' and ending 'o' using regular expression. absorber.setPhrase ( "h\w*?o"); absorber.setTextSearchOptions ( new TextSearchOptions(true)); // we should find "hello" word and replace it with "Hi" doc.getPages().get(1).accept(absorber); absorber.getTextFragments().get_Item(1).setText ( "Hi"); // Save document doc.save("D:\Tests\output.pdf");
getTextSearchOptions
in class TextAbsorber
public void setTextSearchOptions(TextSearchOptions value)
Sets search options. The options enable search using regular expressions.
setTextSearchOptions
in class TextAbsorber
public TextEditOptions getTextEditOptions()
Gets text edit options. The options define special behavior when requested symbol cannot be written with font.
public void setTextEditOptions(TextEditOptions value)
Sets text edit options. The options define special behavior when requested symbol cannot be written with font.
public void visit(Page page)
Performs search on the specified page.
The example demonstrates how to find text on the first PDF document page and replace the text.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Find font that will be used to change document text font Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page absorber.visit(doc.getPages().get(1)); // Change text of all search occurrences for (TextFragment textFragment : absorber.getTextFragments()) { textFragment.setText ( "hi world"); } // Save document doc.save("D:\Tests\output.pdf");
visit
in class TextAbsorber
public void visit(IDocument pdf)
Performs search on the specified document.
The example demonstrates how to find text on PDF document and replace text of all search occurrences.// Open document Document doc = new Document("D:\Tests\input.pdf"); // Find font that will be used to change document text font Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page absorber.visit(doc); // Change text of the first text occurrence absorber.getTextFragments().get_Item(1).setText ( "hi world"); // Save document doc.save("D:\Tests\output.pdf");
visit
in class TextAbsorber
public void visit(XForm xForm)
Performs search on the specified form object.
visit
in class TextAbsorber
public TextExtractionOptions getExtractionOptions()
Gets or sets text extraction options.
getExtractionOptions
in class TextAbsorber
public void setExtractionOptions(TextExtractionOptions value)
setExtractionOptions
in class TextAbsorber
Copyright © 2017 Aspose. All Rights Reserved.