PdfToTextClient Class

Pdf To Text Conversion with SelectPdf Online API.

Inheritance Hierarchy

SystemObject
SelectPdf.ApiApiClient
SelectPdf.ApiPdfToTextClient

Namespace: SelectPdf.Api
Assembly: SelectPdf.Api (in SelectPdf.Api.dll) Version: 1.4.0

Syntax

Copy

public class PdfToTextClient : ApiClient

Public Class PdfToTextClient
	Inherits ApiClient

The PdfToTextClient type exposes the following members.

Constructors

	Name	Description
	PdfToTextClient	Construct the Pdf To Text Client.

Top

Methods

	Name	Description
	getNumberOfPages	Get the number of pages processed from the PDF document.
	getTextFromFile	Get the text from the specified pdf.
	getTextFromFileAsync	Get the text from the specified pdf with an asynchronous call.
	getTextFromFileToFile	Get the text from the specified pdf and write it to the specified text file.
	getTextFromFileToFileAsync	Get the text from the specified pdf with an asynchronous call and write it to the specified text file.
	getTextFromFileToStream	Get the text from the specified pdf and write it to the specified stream.
	getTextFromFileToStreamAsync	Get the text from the specified pdf with an asynchronous call and write it to the specified stream.
	getTextFromUrl	Get the text from the specified pdf.
	getTextFromUrlAsync	Get the text from the specified pdf with an asynchronous call.
	getTextFromUrlToFile	Get the text from the specified pdf and write it to the specified text file.
	getTextFromUrlToFileAsync	Get the text from the specified pdf with an asynchronous call and write it to the specified text file.
	getTextFromUrlToStream	Get the text from the specified pdf and write it to the specified stream.
	getTextFromUrlToStreamAsync	Get the text from the specified pdf with an asynchronous call and write it to the specified stream.
	searchFile(String, String)	Search for a specific text in a PDF document. The search is case insensitive and returns partial words also.
	searchFile(String, String, Boolean, Boolean)	Search for a specific text in a PDF document.
	searchFileAsync(String, String)	Search for a specific text in a PDF document with an asynchronous call. The search is case insensitive and returns partial words also.
	searchFileAsync(String, String, Boolean, Boolean)	Search for a specific text in a PDF document with an asynchronous call.
	searchUrl(String, String)	Search for a specific text in a PDF document. The search is case insensitive and returns partial words also.
	searchUrl(String, String, Boolean, Boolean)	Search for a specific text in a PDF document.
	searchUrlAsync(String, String)	Search for a specific text in a PDF document with an asynchronous call. The search is case insensitive and returns partial words also.
	searchUrlAsync(String, String, Boolean, Boolean)	Search for a specific text in a PDF document with an asynchronous call.
	setCustomParameter	Set a custom parameter. Do not use this method unless advised by SelectPdf.
	setEndPage	Set End Page number. Default value is 0 (process till the last page of the document).
	setOutputFormat	Set the output format. The default value is OutputFormat.Text.
	setStartPage	Set Start Page number. Default value is 1 (first page of the document).
	setTextLayout	Set the text layout. The default value is TextLayout.Original.
	setTimeout	Set the maximum amount of time (in seconds) for this job.
	setUserPassword	Set PDF user password.

Top

Examples

Sample Code - Pdf To Text:

Copy

using System;
using SelectPdf.Api;

namespace SelectPdf.Api.Tests
{
    class Program
    {
        static void Main(string[] args)
        {
            string testUrl = "https://selectpdf.com/demo/files/selectpdf.pdf";
            string testPdf = "Input.pdf";
            string localFile = "Result.txt";
            string apiKey = "Your API key here";

            Console.WriteLine("This is SelectPdf-{0}.", ApiClient.CLIENT_VERSION);

            try
            {
                PdfToTextClient client = new PdfToTextClient(apiKey);

                // set parameters - see full list at https://selectpdf.com/pdf-to-text-api/
                client
                    .setStartPage(1) // start page (processing starts from here)
                    .setEndPage(0) // end page (set 0 to process file til the end)
                    .setOutputFormat(OutputFormat.Text) // set output format (0-Text or 1-HTML)
                ;

                Console.WriteLine("Starting pdf to text ...");

                // convert local pdf to local text file
                client.getTextFromFileToFile(testPdf, localFile);

                // extract text from local pdf to memory
                // string text = client.getTextFromFile(testPdf);
                // print text
                // Console.WriteLine(text);

                // convert pdf from public url to local text file
                // client.getTextFromUrlToFile(testUrl, localFile);

                // extract text from pdf from public url to memory
                // string text = client.getTextFromUrl(testUrl);
                // print text
                // Console.WriteLine(text);

                Console.WriteLine("Finished! Number of pages processed: {0}.", client.getNumberOfPages());

                // get API usage
                UsageClient usageClient = new UsageClient(apiKey);
                UsageInformation usage = usageClient.getUsage(false);
                Console.WriteLine("Conversions remained this month: {0}.", usage.Available);
            }
            catch (Exception ex)
            {
                Console.WriteLine("An error occurred: " + ex.Message);
            }
        }
    }
}

Imports SelectPdf.Api

Module Program
    Sub Main(args As String())
        Dim testUrl As String = "https://selectpdf.com/demo/files/selectpdf.pdf"
        Dim testPdf As String = "Input.pdf"
        Dim localFile As String = "Result.txt"
        Dim apiKey As String = "Your API key here"

        Console.WriteLine("This is SelectPdf-{0}.", ApiClient.CLIENT_VERSION)

        Try
            Dim client As PdfToTextClient = New PdfToTextClient(apiKey)

            ' set parameters - see full list at https://selectpdf.com/pdf-to-text-api/

            client.setStartPage(1) ' start page (processing starts from here)
            client.setEndPage(0) ' End page (Set 0 To process file til the End)
            client.setOutputFormat(OutputFormat.Text) ' Set output format (0-Text Or 1-HTML)

            Console.WriteLine("Starting pdf to text ...")

            ' convert local pdf to local text file
            client.getTextFromFileToFile(testPdf, localFile)

            ' extract text from local pdf to memory
            ' Dim text As String = client.getTextFromFile(testPdf)
            ' print text
            ' Console.WriteLine(text)

            ' convert pdf from public url to local text file
            ' client.getTextFromUrlToFile(testUrl, localFile)

            ' extract text from pdf from public url to memory
            ' Dim text As String = client.getTextFromUrl(testUrl)
            ' print text
            ' Console.WriteLine(text)

            Console.WriteLine("Finished! Number of pages processed: {0}.", client.getNumberOfPages())

            ' get API usage
            Dim usageClient As UsageClient = New UsageClient(apiKey)
            Dim usage As UsageInformation = usageClient.getUsage(False)
            Console.WriteLine("Conversions remained this month: {0}.", usage.Available)

        Catch ex As Exception
            Console.WriteLine("An error occurred: " & ex.Message)
        End Try
    End Sub
End Module

Sample Code - Search Pdf:

Copy

using System;
using SelectPdf.Api;

namespace SelectPdf.Api.Tests
{
    class Program
    {
        static void Main(string[] args)
        {
            string testUrl = "https://selectpdf.com/demo/files/selectpdf.pdf";
            string testPdf = "Input.pdf";
            string apiKey = "Your API key here";

            Console.WriteLine("This is SelectPdf-{0}.", ApiClient.CLIENT_VERSION);

            try
            {
                PdfToTextClient client = new PdfToTextClient(apiKey);

                // set parameters - see full list at https://selectpdf.com/pdf-to-text-api/
                client
                    .setStartPage(1) // start page (processing starts from here)
                    .setEndPage(0) // end page (set 0 to process file til the end)
                    .setOutputFormat(OutputFormat.Text) // set output format (0-Text or 1-HTML)
                ;

                Console.WriteLine("Starting search pdf ...");

                // search local pdf
                IList&TextPosition> results = client.searchFile(testPdf, "pdf");

                // search pdf from public url
                // IList&TextPosition> results = client.searchUrl(testUrl, "pdf");

                Console.WriteLine("Search results:\n{0}\nSearch results count: {1}.", string.Join("\n", results), results.Count);

                Console.WriteLine("Finished! Number of pages processed: {0}.", client.getNumberOfPages());

                // get API usage
                UsageClient usageClient = new UsageClient(apiKey);
                UsageInformation usage = usageClient.getUsage(false);
                Console.WriteLine("Conversions remained this month: {0}.", usage.Available);
            }
            catch (Exception ex)
            {
                Console.WriteLine("An error occurred: " + ex.Message);
            }
        }
    }
}

Imports SelectPdf.Api

Module Program
    Sub Main(args As String())
        Dim testUrl As String = "https://selectpdf.com/demo/files/selectpdf.pdf"
        Dim testPdf As String = "Input.pdf"
        Dim apiKey As String = "Your API key here"

        Console.WriteLine("This is SelectPdf-{0}.", ApiClient.CLIENT_VERSION)

        Try
            Dim client As PdfToTextClient = New PdfToTextClient(apiKey)

            ' set parameters - see full list at https://selectpdf.com/pdf-to-text-api/

            client.setStartPage(1) ' start page (processing starts from here)
            client.setEndPage(0) ' End page (Set 0 To process file til the End)
            client.setOutputFormat(OutputFormat.Text) ' Set output format (0-Text Or 1-HTML)

            Console.WriteLine("Starting search pdf ...")

            ' search local pdf
            Dim results As IList(Of TextPosition) = client.searchFile(testPdf, "pdf")

            ' search pdf from public url
            ' Dim results As IList(Of TextPosition) = client.searchUrl(testUrl, "pdf")

            Console.WriteLine("Search results:{0}{1}{0}Search results count: {2}.", Environment.NewLine, String.Join(Environment.NewLine, results), results.Count)

            Console.WriteLine("Finished! Number of pages processed: {0}.", client.getNumberOfPages())

            ' get API usage
            Dim usageClient As UsageClient = New UsageClient(apiKey)
            Dim usage As UsageInformation = usageClient.getUsage(False)
            Console.WriteLine("Conversions remained this month: {0}.", usage.Available)

        Catch ex As Exception
            Console.WriteLine("An error occurred: " & ex.Message)
        End Try
    End Sub
End Module

Reference

SelectPdf.Api Namespace