Class Convert

Encapsulates the conversion of a single document from one format to another.

Inheritance

System.Object

Convert

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: pdftron.PDF

Assembly: PDFNetiOS.dll

Syntax

public class Convert : IDisposable

Methods

CreateOfficeTemplate(Filter, ConversionOptions)

Create a TemplateDocument object from an office file suitable for generating any number of PDFs from supplied template data.
Template filling will be performed entirely within PDFNet, and handles incoming files in .docx, .xlsx, .pptx, .doc format
This method does not perform any template filling and can be expected to return quickly. To do the actual work, use the returned TemplateDocument object (see PDF.TemplateDocument)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static TemplateDocument CreateOfficeTemplate(Filter inData, ConversionOptions options)

Parameters

Type	Name	Description
Filter	inData
ConversionOptions	options	the office to pdf conversion options

Returns

Type	Description
TemplateDocument	A TemplateDocument object which encapsulates this particular office template

CreateOfficeTemplate(String, ConversionOptions)

Create a TemplateDocument object from an office file suitable for generating any number of PDFs from supplied template data.
Template filling will be performed entirely within PDFNet, and handles incoming files in .docx, .xlsx, .pptx, .doc format
This method does not perform any template filling and can be expected to return quickly. To do the actual work, use the returned TemplateDocument object (see PDF.TemplateDocument)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static TemplateDocument CreateOfficeTemplate(string filePath, ConversionOptions options)

Parameters

Type	Name	Description
System.String	filePath	the path to the source document
ConversionOptions	options	the office to pdf conversion options

Returns

Type	Description
TemplateDocument	A TemplateDocument object which encapsulates this particular office template

CreateReflow(Page, String)

Create a Reflow object.

Declaration

public static Reflow CreateReflow(Page in_page, string json_zones)

Parameters

Type	Name	Description
Page	in_page	the Page to convert
System.String	json_zones	pre-recognized zoning information in JSON format

Returns

Type	Description
Reflow	A Reflow object

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

Finalize()

Declaration

protected void Finalize()

FromEmf(PDFDoc, String)

Convert the specified EMF to PDF and append converted pages to the specified PDF document. EMF will be fitted to the page.

Declaration

public static void FromEmf(PDFDoc in_pdfdoc, string in_filename)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to append to
System.String	in_filename	the path to the EMF document to convert

Remarks

This method is available only on Windows platforms.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

FromSVG(PDFDoc, String, SVGConvertOptions)

Convert the specified SVG file to PDF and append converted pages to the specified PDF document.

Declaration

public static void FromSVG(PDFDoc in_doc, string in_filename, SVGConvertOptions svg_options)

Parameters

Type	Name	Description
PDFDoc	in_doc	the PDFDoc to append to
System.String	in_filename	the path to the SVG file to convert
SVGConvertOptions	svg_options	the options to use when converting

FromText(PDFDoc, String, Obj)

Convert the specified plain text file to PDF and append converted pages to the specified PDF document.

Declaration

public static void FromText(PDFDoc in_pdfdoc, string in_filename, Obj options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to append to
System.String	in_filename	the path to the plain text document to convert
Obj	options

Remarks

in_options the conversion options. The availble options are:

Option Name	Type	Note
BytesPerBite	Integer	In bytes. Use for streaming conversion only.
FontFace	String	Set the font face used for the conversion.
FontSize	Integer	Set the font size used for the conversion.
LineHeightMultiplier	Double	Set the line height multiplier used for the conversion.
MarginBottom	Double	In inches. Set the bottom margin of the page.
MarginLeft	Double	In inches. Set the left margin of the page.
MarginRight	Double	In inches. Set the right margin of the page.
MarginTop	Double	In inches. Set the top margin of the page.
PageHeight	Double	In inches. Set the page height.
PageWidth	Double	In inches. Set the page width.
UseSourceCodeFormatting	Boolean	Set whether to use mono font for the conversion.

FromXps(PDFDoc, Byte[], Int32)

Convert the specified XPS document contained in memory to PDF and append converted pages to the specified PDF document.

Declaration

public static void FromXps(PDFDoc in_pdfdoc, byte[] buf, int buf_size)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to append to
System.Byte[]	buf	the buffer containing the xps document
System.Int32	buf_size	the size of the buffer

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

FromXps(PDFDoc, String)

Convert the specified XPS document to PDF and append converted pages to the specified PDF document.

Declaration

public static void FromXps(PDFDoc in_pdfdoc, string in_filename)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to append to
System.String	in_filename	the path to the XPS document to convert

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

OfficeToPDF(PDFDoc, Filter, ConversionOptions)

Convert the an office document (in .docx, .xlsx, .pptx, or .doc format) to pdf and append to the specified PDF document. This conversion is performed entirely within PDFNet, and does not rely on Word interop or any other external functionality.
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static void OfficeToPDF(PDFDoc inDoc, Filter inData, ConversionOptions options)

Parameters

Type	Name	Description
PDFDoc	inDoc
Filter	inData
ConversionOptions	options	the conversion options

Remarks

see StreamingPDFConversion() if you would like more control over the conversion process

OfficeToPDF(PDFDoc, String, ConversionOptions)

Convert the an office document (in .docx, .xlsx, .pptx, or .doc format) to pdf and append to the specified PDF document. This conversion is performed entirely within PDFNet, and does not rely on Word interop or any other external functionality.
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static void OfficeToPDF(PDFDoc inDoc, string inFilename, ConversionOptions options)

Parameters

Type	Name	Description
PDFDoc	inDoc
System.String	inFilename
ConversionOptions	options	the conversion options

Remarks

see StreamingPDFConversion() if you would like more control over the conversion process

RequiresPrinter(String)

Utility function to determine if ToPdf will require the PDFNet printer to convert a specific file to PDF.

Declaration

public static bool RequiresPrinter(string in_filename)

Parameters

Type	Name	Description
System.String	in_filename	the path to the document to be checked

Returns

Type	Description
System.Boolean	true if ToPdf requires the printer to convert the file, false otherwise.

Remarks

Current implementation looks only at the file extension not file contents. If the file extension is missing, false will be returned

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

StreamingPDFConversion(Filter, ConversionOptions)

Create a DocumentConversion object suitable for converting a file to pdf.
This conversion will be performed entirely within PDFNet, and handles incoming files in .docx, .xlsx, .pptx, .doc, .png, .jpg, .bmp, .gif, .jp2, .tif, .txt, .xml and .md format
This method does not perform any conversion logic and can be expected to return quickly. To do the actual conversion, use the returned DocumentConversion object (see PDF.DocumentConversion)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static DocumentConversion StreamingPDFConversion(Filter inData, ConversionOptions options)

Parameters

Type	Name	Description
Filter	inData
ConversionOptions	options	the conversion options

Returns

Type	Description
DocumentConversion	A DocumentConversion object which encapsulates this particular conversion

StreamingPDFConversion(PDFDoc, Filter, ConversionOptions)

Create a DocumentConversion object suitable for converting a file to pdf and appending to an existing PDF document.
This conversion will be performed entirely within PDFNet, and handles incoming files in .docx, .xlsx, .pptx, .doc, .png, .jpg, .bmp, .gif, .jp2, .tif, .txt, .xml and .md format
This method does not perform any conversion logic and can be expected to return quickly. To do the actual conversion, use the returned DocumentConversion object (see PDF.DocumentConversion)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static DocumentConversion StreamingPDFConversion(PDFDoc doc, Filter inData, ConversionOptions options)

Parameters

Type	Name	Description
PDFDoc	doc	the conversion result will be appended to this pdf
Filter	inData
ConversionOptions	options	the conversion options

Returns

Type	Description
DocumentConversion	A DocumentConversion object which encapsulates this particular conversion

StreamingPDFConversion(PDFDoc, String, ConversionOptions)

Create a DocumentConversion object suitable for converting a file to pdf and appending to an existing PDF document.
This conversion will be performed entirely within PDFNet, and handles incoming files in .docx, .xlsx, .pptx, .doc, .png, .jpg, .bmp, .gif, .jp2, .tif, .txt, .xml and .md format
This method does not perform any conversion logic and can be expected to return quickly. To do the actual conversion, use the returned DocumentConversion object (see PDF.DocumentConversion)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static DocumentConversion StreamingPDFConversion(PDFDoc doc, string filePath, ConversionOptions options)

Parameters

Type	Name	Description
PDFDoc	doc	the conversion result will be appended to this pdf
System.String	filePath	the path to the source document
ConversionOptions	options	the conversion options

Returns

Type	Description
DocumentConversion	A DocumentConversion object which encapsulates this particular conversion

StreamingPDFConversion(String, ConversionOptions)

Create a DocumentConversion object suitable for converting a file to pdf.
This conversion will be performed entirely within PDFNet, and handles incoming files in .docx, .xlsx, .pptx, .doc, .png, .jpg, .bmp, .gif, .jp2, .tif, .txt, .xml and .md format
This method does not perform any conversion logic and can be expected to return quickly. To do the actual conversion, use the returned DocumentConversion object (see PDF.DocumentConversion)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static DocumentConversion StreamingPDFConversion(string filePath, ConversionOptions options)

Parameters

Type	Name	Description
System.String	filePath	the path to the source document
ConversionOptions	options	the conversion options

Returns

Type	Description
DocumentConversion	A DocumentConversion object which encapsulates this particular conversion

ToEmf(Page, String)

Convert the Page to EMF and save to the specified path.

Declaration

public static void ToEmf(Page in_page, string in_filename)

Parameters

Type	Name	Description
Page	in_page	the Page to convert to EMF
System.String	in_filename	the path to the EMF file to create

Remarks

This method is available only on Windows platforms.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEmf(PDFDoc, String)

Convert the PDFDoc to EMF and save to the specified path.

Declaration

public static void ToEmf(PDFDoc in_pdfdoc, string in_filename)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to EMF
System.String	in_filename	the path to the EMF files to create, one file per page

Remarks

This method is available only on Windows platforms.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(PDFDoc, String)

Convert the PDFDoc to EPUB format and save to the specified path.

Declaration

public static void ToEpub(PDFDoc in_pdfdoc, string output_path)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to EPUB
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(PDFDoc, String, Convert.EPUBOutputOptions)

Convert the PDFDoc to EPUB format and save to the specified path.

Declaration

public static void ToEpub(PDFDoc in_pdfdoc, string output_path, Convert.EPUBOutputOptions epub_options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to EPUB
System.String	output_path	the path to where generated content will be stored
Convert.EPUBOutputOptions	epub_options	the EPUB conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(PDFDoc, String, Convert.HTMLOutputOptions)

Convert the PDFDoc to EPUB format and save to the specified path.

Declaration

public static void ToEpub(PDFDoc in_pdfdoc, string output_path, Convert.HTMLOutputOptions html_options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to EPUB
System.String	output_path	the path to where generated content will be stored
Convert.HTMLOutputOptions	html_options	the HTML conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(PDFDoc, String, Convert.HTMLOutputOptions, Convert.EPUBOutputOptions)

Convert the PDFDoc to EPUB format and save to the specified path.

Declaration

public static void ToEpub(PDFDoc in_pdfdoc, string output_path, Convert.HTMLOutputOptions html_options, Convert.EPUBOutputOptions epub_options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to EPUB
System.String	output_path	the path to where generated content will be stored
Convert.HTMLOutputOptions	html_options	the HTML conversion options
Convert.EPUBOutputOptions	epub_options	the EPUB conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(String, String)

Convert a file to EPUB format and save to the specified path.

Declaration

public static void ToEpub(string in_filename, string output_path)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to EPUB
System.String	output_path	the path to where generated content will be stored

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(String, String, Convert.EPUBOutputOptions)

Convert a file to EPUB format and save to the specified path.

Declaration

public static void ToEpub(string in_filename, string output_path, Convert.EPUBOutputOptions epub_options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to EPUB
System.String	output_path	the path to where generated content will be stored
Convert.EPUBOutputOptions	epub_options	the EPUB conversion options

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(String, String, Convert.HTMLOutputOptions)

Convert a file to EPUB format and save to the specified path.

Declaration

public static void ToEpub(string in_filename, string output_path, Convert.HTMLOutputOptions html_options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to EPUB
System.String	output_path	the path to where generated content will be stored
Convert.HTMLOutputOptions	html_options	the HTML conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToEpub(String, String, Convert.HTMLOutputOptions, Convert.EPUBOutputOptions)

Convert a file to EPUB format and save to the specified path.

Declaration

public static void ToEpub(string in_filename, string output_path, Convert.HTMLOutputOptions html_options, Convert.EPUBOutputOptions epub_options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to EPUB
System.String	output_path	the path to where generated content will be stored
Convert.HTMLOutputOptions	html_options	the HTML conversion options
Convert.EPUBOutputOptions	epub_options	the EPUB conversion options

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToExcel(PDFDoc, String)

Convert the PDF to Excel and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToExcel(PDFDoc in_pdfdoc, string output_path)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to Excel
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToExcel(PDFDoc, String, Convert.ExcelOutputOptions)

Convert the PDF to Excel and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToExcel(PDFDoc in_pdfdoc, string output_path, Convert.ExcelOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to Excel
System.String	output_path	the path to where generated content will be stored
Convert.ExcelOutputOptions	options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToExcel(String, String)

Convert a PDF file to Excel and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToExcel(string in_filename, string output_path)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to Excel
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToExcel(String, String, Convert.ExcelOutputOptions)

Convert a PDF file to Excel and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToExcel(string in_filename, string output_path, Convert.ExcelOutputOptions options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to Excel
System.String	output_path	the path to where generated content will be stored
Convert.ExcelOutputOptions	options	the conversion options

ToHtml(PDFDoc, String)

Convert the PDF to HTML and save to the specified path.

Declaration

public static void ToHtml(PDFDoc in_pdfdoc, string output_path)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to HTML
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToHtml(PDFDoc, String, Convert.HTMLOutputOptions)

Convert the PDF to HTML and save to the specified path. In e_reflow_paragraphs mode, this conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToHtml(PDFDoc in_pdfdoc, string output_path, Convert.HTMLOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to HTML
System.String	output_path	the path to where generated content will be stored
Convert.HTMLOutputOptions	options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToHtml(String, String)

Convert a file to HTML and save to the specified path.

Declaration

public static void ToHtml(string in_filename, string output_path)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to HTML
System.String	output_path	the path to where generated content will be stored

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToHtml(String, String, Convert.HTMLOutputOptions)

Convert a file to HTML and save to the specified path. In e_reflow_paragraphs mode, this conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToHtml(string in_filename, string output_path, Convert.HTMLOutputOptions options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to HTML
System.String	output_path	the path to where generated content will be stored
Convert.HTMLOutputOptions	options	the conversion options

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToPdf(PDFDoc, String)

Convert the file or document to PDF and append to the specified PDF document.

Declaration

public static void ToPdf(PDFDoc in_pdfdoc, string in_filename)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to append the converted document to. The PDFDoc can then be converted to XPS, EMF or SVG using the other functions in this class.
System.String	in_filename	the path to the document to be converted to XPS

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS. Formats that require external applications for conversion use the Convert::Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToPowerPoint(PDFDoc, String)

Convert the PDF to PowerPoint and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToPowerPoint(PDFDoc in_pdfdoc, string output_path)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to PowerPoint
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToPowerPoint(PDFDoc, String, Convert.PowerPointOutputOptions)

Convert the PDF to PowerPoint and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToPowerPoint(PDFDoc in_pdfdoc, string output_path, Convert.PowerPointOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to PowerPoint
System.String	output_path	the path to where generated content will be stored
Convert.PowerPointOutputOptions	options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToPowerPoint(String, String)

Convert a PDF file to PowerPoint and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToPowerPoint(string in_filename, string output_path)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to PowerPoint
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToPowerPoint(String, String, Convert.PowerPointOutputOptions)

Convert a PDF file to PowerPoint and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToPowerPoint(string in_filename, string output_path, Convert.PowerPointOutputOptions options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to PowerPoint
System.String	output_path	the path to where generated content will be stored
Convert.PowerPointOutputOptions	options	the conversion options

ToSvg(Page, String)

Convert the Page to SVG and save to the specified path.

Declaration

public static void ToSvg(Page in_page, string in_filename)

Parameters

Type	Name	Description
Page	in_page	the Page to convert to SVG
System.String	in_filename	the path to the SVG file to create

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToSvg(Page, String, Convert.SVGOutputOptions)

Convert the Page to SVG and save to the specified path.

Declaration

public static void ToSvg(Page in_page, string in_filename, Convert.SVGOutputOptions in_options)

Parameters

Type	Name	Description
Page	in_page	the Page to convert to SVG
System.String	in_filename	the path to the SVG file to create
Convert.SVGOutputOptions	in_options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToSvg(PDFDoc, String)

Convert the PDFDoc to SVG and save to the specified path.

Declaration

public static void ToSvg(PDFDoc in_pdfdoc, string in_filename)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to SVG
System.String	in_filename	the path to the SVG files to create, one file per page

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToSvg(PDFDoc, String, Convert.SVGOutputOptions)

Convert the PDFDoc to SVG and save to the specified path.

Declaration

public static void ToSvg(PDFDoc in_pdfdoc, string in_filename, Convert.SVGOutputOptions in_options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to SVG
System.String	in_filename	the path to the SVG files to create, one file per page
Convert.SVGOutputOptions	in_options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToTiff(PDFDoc, String)

Convert the PDF to multipage Tiff and save to the specified path.

Declaration

public static void ToTiff(PDFDoc in_pdfdoc, string output_path)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to multipage Tiff
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToTiff(PDFDoc, String, Convert.TiffOutputOptions)

Convert the PDF to multipage Tiff and save to the specified path.

Declaration

public static void ToTiff(PDFDoc in_pdfdoc, string output_path, Convert.TiffOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to multipage Tiff
System.String	output_path	the path to where generated content will be stored
Convert.TiffOutputOptions	options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToTiff(String, String)

Convert a file to multipage Tiff and save to the specified path.

Declaration

public static void ToTiff(string in_filename, string output_path)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to multipage Tiff
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToTiff(String, String, Convert.TiffOutputOptions)

Convert a file to multipage Tiff and save to the specified path.

Declaration

public static void ToTiff(string in_filename, string output_path, Convert.TiffOutputOptions options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to multipage Tiff
System.String	output_path	the path to where generated content will be stored
Convert.TiffOutputOptions	options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToWord(PDFDoc, String)

Convert the PDF to Word and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToWord(PDFDoc in_pdfdoc, string output_path)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to Word
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToWord(PDFDoc, String, Convert.WordOutputOptions)

Convert the PDF to Word and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToWord(PDFDoc in_pdfdoc, string output_path, Convert.WordOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDF doc to convert to Word
System.String	output_path	the path to where generated content will be stored
Convert.WordOutputOptions	options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToWord(String, String)

Convert a PDF file to Word and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToWord(string in_filename, string output_path)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to Word
System.String	output_path	the path to where generated content will be stored

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToWord(String, String, Convert.WordOutputOptions)

Convert a PDF file to Word and save to the specified path. This conversion requires that the optional PDFTron StructuredOutput add-on module is available. See also: the StructuredOutputModule class

Declaration

public static void ToWord(string in_filename, string output_path, Convert.WordOutputOptions options)

Parameters

Type	Name	Description
System.String	in_filename	the file to convert to Word
System.String	output_path	the path to where generated content will be stored
Convert.WordOutputOptions	options	the conversion options

ToXod(PDFDoc)

Generate a stream that incrementally converts the input file to XOD format.

Declaration

public static Filter ToXod(PDFDoc in_pdfdoc)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to XPS

Returns

Type	Description
Filter	converted file in Stream

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXod(PDFDoc, Convert.XODOutputOptions)

Generate a stream that incrementally converts the input file to XOD format.

Declaration

public static Filter ToXod(PDFDoc in_pdfdoc, Convert.XODOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to XPS
Convert.XODOutputOptions	options	the conversion options

Returns

Type	Description
Filter	converted file in Stream

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXod(PDFDoc, String)

Convert the PDFDoc to XOD format and save to the specified path.

Declaration

public static void ToXod(PDFDoc in_pdfdoc, string out_filename)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to XPS
System.String	out_filename	the out_filename

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXod(PDFDoc, String, Convert.XODOutputOptions)

Convert the PDFDoc to XOD format and save to the specified path.

Declaration

public static void ToXod(PDFDoc in_pdfdoc, string out_filename, Convert.XODOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to XPS
System.String	out_filename	the out_filename
Convert.XODOutputOptions	options	the conversion options

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXod(String)

Generate a stream that incrementally converts the input file to XOD format.

Declaration

public static Filter ToXod(string in_filename)

Parameters

Type	Name	Description
System.String	in_filename	the in_filename

Returns

Type	Description
Filter	converted XPS file as Stream

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXod(String, Convert.XODOutputOptions)

Generate a stream that incrementally converts the input file to XOD format.

Declaration

public static Filter ToXod(string in_filename, Convert.XODOutputOptions options)

Parameters

Type	Name	Description
System.String	in_filename	the in_filename
Convert.XODOutputOptions	options	the conversion options

Returns

Type	Description
Filter	converted file as Stream

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXod(String, String)

Convert the input file to XOD format and save to the specified path.

Declaration

public static void ToXod(string in_filename, string out_filename)

Parameters

Type	Name	Description
System.String	in_filename	the in_filename
System.String	out_filename	the out_filename

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXod(String, String, Convert.XODOutputOptions)

Convert the input file to XOD format and save to the specified path.

Declaration

public static void ToXod(string in_filename, string out_filename, Convert.XODOutputOptions options)

Parameters

Type	Name	Description
System.String	in_filename	the in_filename
System.String	out_filename	the out_filename
Convert.XODOutputOptions	options	the conversion options

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS, PDF. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXps(PDFDoc, String)

Convert the PDFDoc to XPS and save to the specified path.

Declaration

public static void ToXps(PDFDoc in_pdfdoc, string in_filename)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to XPS
System.String	in_filename	the path to the document to create

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXps(PDFDoc, String, Convert.XPSOutputOptions)

Convert the PDFDoc to XPS and save to the specified path.

Declaration

public static void ToXps(PDFDoc in_pdfdoc, string in_filename, Convert.XPSOutputOptions options)

Parameters

Type	Name	Description
PDFDoc	in_pdfdoc	the PDFDoc to convert to XPS
System.String	in_filename	the path to the document to create
Convert.XPSOutputOptions	options	the conversion options

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXps(String, String)

Convert the file or document to XPS and write to the specified file.

Declaration

public static void ToXps(string in_inputFilename, string in_outputFilename)

Parameters

Type	Name	Description
System.String	in_inputFilename	the path to the document to be converted to XPS
System.String	in_outputFilename	the path to the output XPS file

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

ToXps(String, String, Convert.XPSOutputOptions)

Convert the file or document to XPS and write to the specified file.

Declaration

public static void ToXps(string in_inputFilename, string in_outputFilename, Convert.XPSOutputOptions options)

Parameters

Type	Name	Description
System.String	in_inputFilename	the path to the document to be converted to XPS
System.String	in_outputFilename	the path to the output XPS file
Convert.XPSOutputOptions	options	the conversion options

Remarks

Internally formats include BMP, EMF, JPEG, PNG, TIF, XPS. Formats that require external applications for conversion use the Convert.Printer class and the PDFNet printer to be installed. This is only supported on Windows platforms. Document formats in this category include RTF(MS Word or Wordpad), TXT (Notepad or Wordpad), DOC and DOCX (MS Word), PPT and PPTX (MS PowerPoint), XLS and XLSX (MS Excel), OpenOffice documents, HTML and MHT (Internet Explorer), PUB (MS Publisher), MSG (MS Outlook).

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

WordToPDF(PDFDoc, Filter, WordToPDFOptions)

Convert the a Word document (in .docx format) to pdf and append to the specified PDF document. This conversion is performed entirely within PDFNet, and does not rely on Word interop or any other external functionality.
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static void WordToPDF(PDFDoc inDoc, Filter inData, WordToPDFOptions options)

Parameters

Type	Name	Description
PDFDoc	inDoc
Filter	inData
WordToPDFOptions	options	the conversion options

Remarks

see WordToPdfConversion() if you would like more control over the conversion process

WordToPDF(PDFDoc, String, WordToPDFOptions)

Convert the a Word document (in .docx format) to pdf and append to the specified PDF document. This conversion is performed entirely within PDFNet, and does not rely on Word interop or any other external functionality.
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static void WordToPDF(PDFDoc inDoc, string inFilename, WordToPDFOptions options)

Parameters

Type	Name	Description
PDFDoc	inDoc
System.String	inFilename
WordToPDFOptions	options	the conversion options

Remarks

see WordToPdfConversion() if you would like more control over the conversion process

WordToPDFConversion(PDFDoc, Filter, WordToPDFOptions)

Create a DocumentConversion object suitable for converting a Word document (in .docx format) to pdf and appending to the specified PDF document. This conversion will be performed entirely within PDFNet, and does not rely on Word interop or any other external functionality.
This method allows for more control over the conversion process than the single call WordToPDF() interface. This method does not perform any conversion logic and can be expected to return quickly. To do the actual conversion, use the returned DocumentConversion object (see PDF.DocumentConversion)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static DocumentConversion WordToPDFConversion(PDFDoc doc, Filter inData, WordToPDFOptions options)

Parameters

Type	Name	Description
PDFDoc	doc	the conversion result will be appended to this pdf
Filter	inData
WordToPDFOptions	options	the conversion options

Returns

Type	Description
DocumentConversion	A DocumentConversion object which encapsulates this particular conversion

Remarks

see WordToPdfConversion() if you would like more control over the conversion process

WordToPDFConversion(PDFDoc, String, WordToPDFOptions)

Create a DocumentConversion object suitable for converting a Word document (in .docx format) to pdf and appending to the specified PDF document. This conversion will be performed entirely within PDFNet, and does not rely on Word interop or any other external functionality.
This method allows for more control over the conversion process than the single call WordToPDF() interface. This method does not perform any conversion logic and can be expected to return quickly. To do the actual conversion, use the returned DocumentConversion object (see PDF.DocumentConversion)
Font requirements: on some systems you may need to specify extra font resources to aid in conversion. Please see http://www.pdftron.com/kb_fonts_and_builtin_office_conversion

Declaration

public static DocumentConversion WordToPDFConversion(PDFDoc doc, string filePath, WordToPDFOptions options)

Parameters

Type	Name	Description
PDFDoc	doc	the conversion result will be appended to this pdf
System.String	filePath	the path to the source document. The source must be in .docx format.
WordToPDFOptions	options	the conversion options

Returns

Type	Description
DocumentConversion	A DocumentConversion object which encapsulates this particular conversion

Remarks

see WordToPdfConversion() if you would like more control over the conversion process

Explicit Interface Implementations

IDisposable.Dispose()

Declaration

void IDisposable.Dispose()

Implements

System.IDisposable