Skip to main content

class Wacom::Kiosk::Pdf::PdfHelper

class Wacom::Kiosk::Pdf::PdfHelper
  : public IDisposable

See also: System.IDisposable

Summary​

MembersDescriptions
{property} int???? DocumentPagesCount
public inline PdfHelper(ILogger logger)
public inline string GetSignatureInfo(string pdfDocPath,string fieldName)Returns string with signatory name & date and time of signature.
public inline PdfHelper Initialize(string filePath)Initializes the PDF helper with a PDF document from a file path.
public inline PdfHelper Initialize(MemoryStream memoryStream)Initializes the PDF helper with a PDF document from a memory stream.
public inline string ParsePage(int pageNum,int? imageWidth)Parses a page from the currently initialized PDF document.
public inline string ParsePage(string filePath,int pageNum,int? imageWidth)Parses the page.
public inline string ParsePage(Stream pdfFile,int pageNum,int? imageWidth)Parses the page.
public inline string ParsePage(byte[] pdfFile,int pageNum,int? imageWidth)Parses the page.
public inline List< string > ParsePages(string filePath,int? imagesWidth)Parses the pages.
public inline List< string > ParsePages(Stream pdfFile,int? imagesWidth)Parses the pages.
public inline List< string > ParsePages(byte[] pdfFile,int? imagesWidth)Parses the pages.
public inline string GetThumbnails(int from,int to)Gets the thumbnails.
public inline void Dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Members​

{property} int???? DocumentPagesCount​

public inline PdfHelper(ILogger logger)​

public inline string GetSignatureInfo(string pdfDocPath,string fieldName)​

Returns string with signatory name & date and time of signature.

Parameters​

  • pdfDocPath Filename of PDF document.

  • fieldName Name of signature field.

Returns​

Signature details if signed, otherwise null.

Can also be used to determine if the given field has been signed.

public inline PdfHelper Initialize(string filePath)​

Initializes the PDF helper with a PDF document from a file path.

Parameters​

  • filePath The file path to the PDF document.

Returns​

The current instance of PdfHelper.

public inline PdfHelper Initialize(MemoryStream memoryStream)​

Initializes the PDF helper with a PDF document from a memory stream.

Parameters​

  • memoryStream The memory stream containing the PDF document.

Returns​

The current instance of PdfHelper.

public inline string ParsePage(int pageNum,int? imageWidth)​

Parses a page from the currently initialized PDF document.

Parameters​

  • pageNum The page number to parse.

  • imageWidth The width of the image (optional).

Returns​

A JSON string representation of the parsed page.

public inline string ParsePage(string filePath,int pageNum,int? imageWidth)​

Parses the page.

Parameters​

  • filePath The file path.

  • pageNum The page number.

  • imageWidth Width of the image.

Returns​

public inline string ParsePage(Stream pdfFile,int pageNum,int? imageWidth)​

Parses the page.

Parameters​

  • pdfFile The PDF file.

  • pageNum The page number.

  • imageWidth Width of the image.

Returns​

Json string.

public inline string ParsePage(byte[] pdfFile,int pageNum,int? imageWidth)​

Parses the page.

Parameters​

  • pdfFile The PDF file.

  • pageNum The page number.

  • imageWidth Width of the image.

Returns​

Json string.

public inline List< string > ParsePages(string filePath,int? imagesWidth)​

Parses the pages.

Parameters​

  • filePath The file path.

  • imagesWidth Width of the image.

Returns​

List fo Json strings.

public inline List< string > ParsePages(Stream pdfFile,int? imagesWidth)​

Parses the pages.

Parameters​

  • pdfFile The PDF file.

  • imagesWidth Width of the image.

Returns​

List fo Json strings.

public inline List< string > ParsePages(byte[] pdfFile,int? imagesWidth)​

Parses the pages.

Parameters​

  • pdfFile The PDF file.

  • imagesWidth Width of the image.

Returns​

List fo Json strings.

public inline string GetThumbnails(int from,int to)​

Gets the thumbnails.

Parameters​

  • from From.

  • to To.

Returns​

Json string with thumbnail images in base64 format.

Exceptions​

  • Exception

public inline void Dispose()​

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.