Click or drag to resize

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
public sealed class DocumentConversion : IClosable

The DocumentConversion type exposes the following members.

Methods
  NameDescription
Public methodCancelConversion
Cancel the current conversion, forcing TryConvert or Convert to return.
Public methodClose
Public methodConvert
Perform the conversion. Will throw an exception on failure.
Public methodConvertNextPage
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.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetConversionStatus
Get the state of the conversion process. Pair this with ConvertNextPage().
Public methodGetDoc
Gets the PDFDoc from the conversion. Can be accessed at any time during or after conversion.
Public methodGetErrorString
If the conversion finsihed with some kind of error, this returns the value of the the error description ()otherwise returns an empty string.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetNumConvertedPages
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".
Public methodGetNumWarnings
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.
Public methodGetProgress
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).
Public methodGetProgressLabel
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.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWarningString
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.
Public methodHasProgressTracking
Determine whether this DocumentConversion has progress reporting capability.
Public methodIsCancelled
Has the conversion been cancelled?.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryConvert
Perform the conversion. If the result of the conversion is failure, then GetErrorString will contain further information about the failure.
Top
See Also