Convert Class

Converter is a utility class used to convert documents and files to PDF. Conversion of XPS, EMF and image files to PDF documents is performed internally. Other document formats are converted via native application and printing.

Inheritance Hierarchy

SystemObject
pdftron.PDFConvert

Namespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class Convert : IClosable

Public NotInheritable Class Convert
	Implements IClosable

public ref class Convert sealed : IClosable

pdftron.PDF.Convert = function();

Type.createClass(
	'pdftron.PDF.Convert',
	null,
	Windows.Foundation.IClosable);

The Convert type exposes the following members.

Methods

	Name	Description
	Close
	CreateReflow	Create a Reflow object.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FromEmf	Converts the specified EMF file to PDF and append converted pages to the specified PDF document. The EMF will be fitted to the page.
	FromEmfAsync(PDFDoc, IFilter)	Convert the specified CAD file to PDF and append converted pages to the specified PDF document. This conversion requires that the optional PDFTron CAD add-on module is available. See also: the 'CADModule' class
	FromEmfAsync(PDFDoc, IStorageFile)	Converts the specified EMF file to PDF and append converted pages to the specified PDF document. The EMF will be fitted to the page.
	FromText	Convert the specified plain text file to PDF and append converted pages to the specified PDF document.
	FromTextAsync	Convert the specified plain text file to PDF and append converted pages to the specified PDF document.
	FromXps(PDFDoc, Byte)	Converts the specified XPS document contained in memory to PDF and append converted pages to the specified PDF document.
	FromXps(PDFDoc, String)	Convert the specified XPS document to PDF and append converted pages to the specified PDF document.
	FromXpsAsync(PDFDoc, IFilter)	Converts the specified XPS file to PDF and append converted pages to the specified PDF document. The EMF will be fitted to the page.
	FromXpsAsync(PDFDoc, IStorageFile)	Converts the specified XPS file to PDF and append converted pages to the specified PDF document. The EMF will be fitted to the page.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	OfficeToPDF(PDFDoc, IFilter, IConversionOptions)	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
	OfficeToPDF(PDFDoc, String, IConversionOptions)	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
	StreamingPDFConversion(String, IConversionOptions)	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
	StreamingPDFConversion(IFilter, IConversionOptions)	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
	StreamingPDFConversion(PDFDoc, IFilter, IConversionOptions)	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
	StreamingPDFConversion(PDFDoc, String, IConversionOptions)	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
	StreamingPDFConversionAsync(IStorageFile, IConversionOptions)	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 and .tif 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
	StreamingPDFConversionAsync(PDFDoc, IStorageFile, IConversionOptions)	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 and .tif 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
	ToEpub	Convert the PDFDoc to Epub and save to the specified path.
	ToEpubAsync	Convert the PDFDoc to Epub and save to the specified path.
	ToPdf	Converts the file or document to PDF and append to the specified PDF document.
	ToPdfAsync(PDFDoc, IStorageFile)	Converts the file or document to PDF and append to the specified PDF document.
	ToPdfAsync(PDFDoc, IFilter, String)	Converts the file or document to PDF and append to the specified PDF document.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToSvg(Page, String)	Convert the Page to SVG and save to the specified path.
	ToSvg(PDFDoc, String)	Convert the PDFDoc to SVG and save to the specified path.
	ToSvg(Page, String, SVGOutputOptions)	Convert the Page to SVG and save to the specified path.
	ToSvg(PDFDoc, String, SVGOutputOptions)
	ToSvgAsync(Page, String)	Convert the Page to SVG and save to the specified path.
	ToSvgAsync(Page, String, SVGOutputOptions)	Convert the Page to SVG and save to the specified path.
	ToXod(String)	Generate a stream that incrementally converts the input file to XOD format.
	ToXod(PDFDoc)	Converts the input PDFDoc to XOD format.
	ToXod(String, XODOutputOptions)	Generate a stream that incrementally converts the input file to XOD format.
	ToXod(String, String)	Converts the input to XOD format.
	ToXod(PDFDoc, XODOutputOptions)	Generate a stream that incrementally converts the input file to XOD format.
	ToXod(String, String, XODOutputOptions)	Converts the input to XOD format.
	ToXodAsync(IFilter)	Converts the input Filter to XOD format.
	ToXodAsync(PDFDoc)	Converts the input PDFDoc to XOD format.
	ToXodAsync(IFilter, IFilter)	Converts the input to XOD format.
	ToXodAsync(IFilter, XODOutputOptions)	Converts the input Filter to XOD format.
	ToXodAsync(PDFDoc, XODOutputOptions)	Converts the input PDFDoc to XOD format.
	ToXodAsync(IFilter, IFilter, XODOutputOptions)	Converts the input to XOD format.
	ToXodWithMonitor	Converts the input PDFDoc to XOD format.
	ToXps(String, String)	Converts an input file to XPS format.
	ToXps(String, String, XPSOutputOptions)	Converts an input file to XPS format.
	UniversalConversion(String, WordToPDFOptions)	Create a DocumentConversion object suitable for converting a document to pdf. 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
	UniversalConversion(IFilter, WordToPDFOptions)	Create a DocumentConversion object suitable for converting a document to pdf. 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
	WordToPDF(PDFDoc, IFilter, 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
	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
	WordToPDFConversion(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
	WordToPDFConversion(IFilter, 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

Top

Examples

Copy

PDFDoc pdfdoc;
Convert.FromXps(pdfdoc, input_path + "simple-xps.xps");
Convert.FromEmf(pdfdoc, input_path + "simple-emf.emf");
Convert.ToPdf(pdfdoc, input_path + test docx file.docx);

Reference

pdftron.PDF Namespace