Class BarcodeModule

static interface to Apryse SDK's barcode extraction functionality

Inheritance

object

BarcodeModule

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public sealed class BarcodeModule

Constructors

BarcodeModule()

Declaration

public BarcodeModule()

Methods

ExtractBarcodes(PDFDoc, string)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and save a JSON array of detected barcodes to the specified file. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

Declaration

public static void ExtractBarcodes(PDFDoc src, string output_file_path)

Parameters

Type	Name	Description
PDFDoc	src	The source document.
string	output_file_path	The path to the output file.

ExtractBarcodes(PDFDoc, string, BarcodeOptions)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and save a JSON array of detected barcodes to the specified file. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

Declaration

public static void ExtractBarcodes(PDFDoc src, string output_file_path, BarcodeOptions options)

Parameters

Type	Name	Description
PDFDoc	src	The source document.
string	output_file_path	The path to the output file.
BarcodeOptions	options	Barcode options (optional).

ExtractBarcodesAsString(PDFDoc)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and return a JSON array of detected barcodes as a string. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

Declaration

public static string ExtractBarcodesAsString(PDFDoc src)

Parameters

Type	Name	Description
PDFDoc	src	The source document.

Returns

Type	Description
string	JSON string representing barcode extraction results.

ExtractBarcodesAsString(PDFDoc, BarcodeOptions)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and return a JSON array of detected barcodes as a string. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

Declaration

public static string ExtractBarcodesAsString(PDFDoc src, BarcodeOptions options)

Parameters

Type	Name	Description
PDFDoc	src	The source document.
BarcodeOptions	options	Barcode options (optional).

Returns

Type	Description
string	JSON string representing barcode extraction results.

IsModuleAvailable()

Find out whether the Barcode Extraction Module is available (and licensed).

Declaration

public static bool IsModuleAvailable()

Returns

Type	Description
bool	Returns true if barcode extraction can be performed.