Link Search Menu Expand Document

Replace Text From URL Asynchronously - C#

PDF Search and Replace Text sample in C# demonstrating ‘Replace Text From URL Asynchronously’

using System;
using System.IO;
using System.Net;
using Newtonsoft.Json.Linq;
using System.Threading;
using System.Collections.Generic;
using Newtonsoft.Json;

// Cloud API asynchronous "Replace Text from PDF" job example.

namespace ByteScoutWebApiExample
	class Program
		// The authentication key (API Key).
		// Get your own by registering at
		const String API_KEY = "***********************************";
		// Direct URL of source PDF file.
        // You can also upload your own file into and use it as url. Check "Upload File" samples for code snippets:
		const string SourceFileUrl = "";
		// PDF document password. Leave empty for unprotected documents.
		const string Password = "";
		// Destination PDF file name
		const string DestinationFile = @".\result.pdf";
		// (!) Make asynchronous job
		const bool Async = true;

		static void Main(string[] args)
			// Create standard .NET web client instance
			WebClient webClient = new WebClient();

			// Set API Key
			webClient.Headers.Add("x-api-key", API_KEY);

			// URL for `Replace Text from PDF` API call
			string url = "";

			// Prepare requests params as JSON
			Dictionary<string, object> parameters = new Dictionary<string, object>();
			parameters.Add("name", Path.GetFileName(DestinationFile));
			parameters.Add("password", Password);
			parameters.Add("url", SourceFileUrl);
			parameters.Add("async", Async);
			parameters.Add("searchString", "Your Company Name");
			parameters.Add("replaceString", "XYZ LLC");

			// Convert dictionary of params to JSON
			string jsonPayload = JsonConvert.SerializeObject(parameters);

				// Execute POST request with JSON payload
				string response = webClient.UploadString(url, jsonPayload);

				// Parse JSON response
				JObject json = JObject.Parse(response);

				if (json["error"].ToObject<bool>() == false)
					// Asynchronous job ID
					string jobId = json["jobId"].ToString();
					// URL of generated PDF file that will available after the job completion
					string resultFileUrl = json["url"].ToString();

					// Check the job status in a loop. 
					// If you don't want to pause the main thread you can rework the code 
					// to use a separate thread for the status checking and completion.
						string status = CheckJobStatus(jobId); // Possible statuses: "working", "failed", "aborted", "success".

						// Display timestamp and status (for demo purposes)
						Console.WriteLine(DateTime.Now.ToLongTimeString() + ": " + status);

						if (status == "success")
							// Download PDF file
							webClient.DownloadFile(resultFileUrl, DestinationFile);

							Console.WriteLine("Generated PDF file saved as \"{0}\" file.", DestinationFile);
						else if (status == "working")
							// Pause for a few seconds
					while (true);
			catch (WebException e)


			Console.WriteLine("Press any key...");

		static string CheckJobStatus(string jobId)
			using (WebClient webClient = new WebClient())
				// Set API Key
                webClient.Headers.Add("x-api-key", API_KEY);
				string url = "" + jobId;

				string response = webClient.DownloadString(url);
				JObject json = JObject.Parse(response);

				return Convert.ToString(json["status"]);
} Web API: the Web API with a set of tools for documents manipulation, data conversion, data extraction, splitting and merging of documents. Includes image recognition, built-in OCR, barcode generation and barcode decoders to decode bar codes from scans, pictures and pdf.

Get your API key here!

Download Source Code (.zip)

return to the previous page explore PDF Search and Replace Text endpoint