Search Text And Add Hyperlink

This tutorial explains how to use Aspose.PDF for .NET to search for specific text in a PDF document, add a hyperlink to the found text, and save the modified document. The provided C# source code demonstrates the process step by step.

Prerequisites

Before proceeding with the tutorial, make sure you have the following:

Basic knowledge of C# programming language.
Aspose.PDF for .NET library installed. You can obtain it from the Aspose website or use NuGet to install it in your project.

Step 1: Set up the project

Start by creating a new C# project in your preferred integrated development environment (IDE) and add a reference to the Aspose.PDF for .NET library.

Step 2: Import necessary namespaces

Add the following using directives at the beginning of your C# file to import the required namespaces:

using Aspose.Pdf;
using Aspose.Pdf.Content;
using Aspose.Pdf.Facades;
using Aspose.Pdf.Text;

Step 3: Set the path to the document directory

Set the path to your document directory using the dataDir variable:

string dataDir = "YOUR DOCUMENT DIRECTORY";

Replace "YOUR DOCUMENT DIRECTORY" with the actual path to your document directory.

Step 4: Create a TextFragmentAbsorber

Create a TextFragmentAbsorber object to find all instances of the input search phrase:

TextFragmentAbsorber absorber = new TextFragmentAbsorber("\\d{4}-\\d{4}");

Replace "\\d{4}-\\d{4}" with your desired regular expression pattern.

Step 5: Enable regular expression search

Enable regular expression search by setting the TextSearchOptions property of the absorber:

absorber.TextSearchOptions = new TextSearchOptions(true);

Step 6: Open and bind the PDF document

Create a PdfContentEditor object and bind it to the source PDF file:

PdfContentEditor editor = new PdfContentEditor();
editor.BindPdf(dataDir + "SearchRegularExpressionPage.pdf");

Replace "SearchRegularExpressionPage.pdf" with the actual name of your PDF file.

Step 7: Accept the absorber for the page

Accept the absorber for the desired page of the document:

editor.Document.Pages[1].Accept(absorber);

Replace 1 with the desired page number.

Step 8: Add hyperlinks to the found text

Loop through the retrieved text fragments and add hyperlinks to them:

foreach (TextFragment textFragment in absorber.TextFragments)
{
    textFragment.TextState.ForegroundColor = Aspose.Pdf.Color.Blue;
    // Create a rectangle based on the text fragment's position
    System.Drawing.Rectangle rect = new System.Drawing.Rectangle((int)textFragment.Rectangle.LLX,
        (int)Math.Round(textFragment.Rectangle.LLY), (int)Math.Round(textFragment.Rectangle.Width + 2),
        (int)Math.Round(textFragment.Rectangle.Height + 1));
    // Add a web link to the rectangle
    editor.CreateWebLink(rect, "http://www.aspose.com", 1, System.Drawing.Color.Blue);
}

Replace "http://www.aspose.com" with the desired hyperlink URL.

Step 9: Save and close the modified document

Save the modified document and close the editor:

dataDir = dataDir + "SearchTextAndAddHyperlink_out.pdf";
editor.Save(dataDir);
editor.Close();
Console.WriteLine("\nText replaced and hyperlink added successfully based on a regular expression.\nFile saved at " + dataDir);

Make sure to replace "SearchTextAndAddHyperlink_out.pdf" with the desired output file name.

Sample source code for Search Text And Add Hyperlink using Aspose.PDF for .NET

// The path to the documents directory.
string dataDir = "YOUR DOCUMENT DIRECTORY";
// Create absorber object to find all instances of the input search phrase
TextFragmentAbsorber absorber = new TextFragmentAbsorber("\\d{4}-\\d{4}");
// Enable regular expression search
absorber.TextSearchOptions = new TextSearchOptions(true);
// Open document
PdfContentEditor editor = new PdfContentEditor();
// Bind source PDF file
editor.BindPdf(dataDir + "SearchRegularExpressionPage.pdf");
// Accept the absorber for the page
editor.Document.Pages[1].Accept(absorber);
int[] dashArray = { };
String[] LEArray = { };
System.Drawing.Color blue = System.Drawing.Color.Blue;
// Loop through the fragments
foreach (TextFragment textFragment in absorber.TextFragments)
{
	textFragment.TextState.ForegroundColor = Aspose.Pdf.Color.Blue;
	System.Drawing.Rectangle rect = new System.Drawing.Rectangle((int)textFragment.Rectangle.LLX,
		(int)Math.Round(textFragment.Rectangle.LLY), (int)Math.Round(textFragment.Rectangle.Width + 2),
		(int)Math.Round(textFragment.Rectangle.Height + 1));
	Enum[] actionName = new Enum[2] { Aspose.Pdf.Annotations.PredefinedAction.Document_AttachFile, Aspose.Pdf.Annotations.PredefinedAction.Document_ExtractPages };
	editor.CreateWebLink(rect, "http:// Www.aspose.com", 1, blue, actionName);
	editor.CreateLine(rect, "", (float)textFragment.Rectangle.LLX + 1, (float)textFragment.Rectangle.LLY - 1,
		(float)textFragment.Rectangle.URX, (float)textFragment.Rectangle.LLY - 1, 1, 1, blue, "S", dashArray, LEArray);
}
dataDir = dataDir + "SearchTextAndAddHyperlink_out.pdf";
editor.Save(dataDir);
editor.Close();
Console.WriteLine("\nText replaced and hyperlink added successfully based on a regular expression.\nFile saved at " + dataDir);

Conclusion

Congratulations! You have successfully learned how to search for specific text in a PDF document, add hyperlinks to the found text, and save the modified document using Aspose.PDF for .NET. This tutorial provided a step-by-step guide, from setting up the project to performing the required actions. You can now incorporate this code into your own C# projects to manipulate text and add hyperlinks in PDF files.

FAQ’s

Q: What is the purpose of the “Search Text And Add Hyperlink” tutorial?

A: The “Search Text And Add Hyperlink” tutorial aims to demonstrate how to use the Aspose.PDF library for .NET to search for specific text within a PDF document, add hyperlinks to the found text, and then save the modified document. The tutorial provides a comprehensive guide and C# code samples to illustrate the step-by-step process.

Q: How does this tutorial help in adding hyperlinks to specific text in a PDF document?

A: This tutorial guides you through the process of using the Aspose.PDF library to locate specific text in a PDF document, apply a hyperlink to the identified text, and save the modified PDF. It covers essential steps such as setting up the project, loading the document, enabling regular expression search, and adding hyperlinks to the found text.

Q: What prerequisites are needed to follow this tutorial?

A: Before you start, you should have a basic understanding of the C# programming language. Additionally, you need to have the Aspose.PDF for .NET library installed, which can be obtained from the Aspose website or installed using NuGet in your project.

Q: How do I set up my project to follow this tutorial?

A: Begin by creating a new C# project in your preferred integrated development environment (IDE). Then, add a reference to the Aspose.PDF for .NET library, which will enable you to utilize the library’s capabilities in your project.

Q: Can I add hyperlinks to specific text using this tutorial?

A: Yes, this tutorial specifically focuses on adding hyperlinks to specific text in a PDF document. It demonstrates how to find and extract the desired text using regular expressions, create hyperlinks associated with the text fragments, and save the modified PDF.

Q: How do I define the text I want to search for and add a hyperlink to?

A: To specify the text you want to search for and add a hyperlink to, create a TextFragmentAbsorber object and set its pattern using the Text parameter. Replace the default pattern "\\d{4}-\\d{4}" in the tutorial’s code with your desired regular expression pattern.

Q: How can I enable regular expression search for text?

A: Regular expression search is enabled by creating a TextSearchOptions object and setting its value to true. Assign this object to the TextSearchOptions property of the TextFragmentAbsorber instance. This ensures that the regular expression pattern is applied during text search.

Q: How do I add hyperlinks to the found text?

A: After identifying the text fragments using the TextFragmentAbsorber, the tutorial provides a loop to iterate through these fragments. For each text fragment, the tutorial demonstrates how to set the text color to blue and create a hyperlink using the CreateWebLink method.

Q: What are the steps to save the modified PDF with hyperlinks?

A: After adding hyperlinks to the desired text fragments, use the PdfContentEditor class to save the modified document. The tutorial’s sample code showcases how to save the edited PDF, close the editor, and display a success message.

Search Regular Expression In PDF File Search Text And Draw Rectangle