DocumentConversion Class

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

Inheritance Hierarchy

SystemObject
pdftron.PDFDocumentConversion

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

Syntax

C++

JavaScript

Copy

public sealed class DocumentConversion : IClosable

Public NotInheritable Class DocumentConversion
	Implements IClosable

public ref class DocumentConversion sealed : IClosable

pdftron.PDF.DocumentConversion = function();

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

The DocumentConversion type exposes the following members.

Methods

	Name	Description
	CancelConversion	Cancel the current conversion, forcing TryConvert or Convert to return.
	Close
	Convert	Perform the conversion. Will throw an exception on failure.
	ConvertNextPage	Perform the conversion. Will throw an exception on failure. Does nothing if the conversion is already complete. Use GetConversionStatus() to check if there is remaining content to be converted.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetConversionStatus	Get the state of the conversion process. Pair this with ConvertNextPage().
	GetDoc	Gets the PDFDoc from the conversion. Can be accessed at any time during or after conversion.
	GetErrorString	If the conversion finsihed with some kind of error, this returns the value of the error description; otherwise returns an empty string.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetNumConvertedPages	Returns the number of pages which have been added to the destination document. Will never decrease, and will not change after the conversion status becomes "complete".
	GetNumWarnings	Return the number of warning strings generated during the conversion process. Warning: experimental interface; this method may be renamed or replaced with equivalent functionality in the future.
	GetProgress	Returns a number from 0.0 to 1.0, representing the best estimate of conversion progress. This number is only an indicator, and should not be used to dictate program logic (in particular, it is possible for this method to return 1.0 while there is still work to be done. Use GetConversionStatus() to find out when the conversion is fully complete).
	GetProgressLabel	Returns the label for the current conversion stage. May return a blank string. Warning: experimental interface; this method may be renamed or replaced with equivalent functionality in the future.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWarningString	Retrieve warning strings that have been collected during the conversion process. Warning: experimental interface; this method may be renamed or replaced with equivalent functionality in the future.
	HasProgressTracking	Determine whether this DocumentConversion has progress reporting capability.
	IsCancelled	Has the conversion been cancelled?.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryConvert	Perform the conversion. If the result of the conversion is failure, then GetErrorString will contain further information about the failure.

Top

Reference

pdftron.PDF Namespace