IPNDocConvQueueItem Object
Contents
Description
The IPNDocConvQueueItem object is the main object for using the PNDocConvQueueServiceLib COM API to communicate with the Document Conversion Service.
The IPNDocConvQueueItem object also holds the settings used to convert the file. The settings are stored as a dictionary collection of key-value pairs where the key is a unique string for each value. The value can be any object although strings are mainly used.
Settings are added by calling the Set method for each setting you need to configure. You can test for settings using the Contains method, retrieve the settings with the Get methods and remove them using the Remove method.
If you need to convert many files using the same conversion settings you would create a single an IPNDocConvQueueItem object with the desired settings and reuse that same object for each file you want to convert.
If you need to specify different settings for each file you are converting you have the choice of altering the settings collection as needed for each file before converting, or creating an new IPNDocConvQueueItem with its own settings collection for each file.
Two functions, WaitForRunningDocumentConversionService and WaitForAvailableConverterPlugIn allow you to synchronize long running applications such as a watch folder service with the Document Conversion Service being up and running and ready to convert.
Methods
Determines whether the settings collection contains the specified key. |
|
Converts the source file to the output file using the converter specified. |
|
Gets the value associated with the specified key name. |
|
Removes the value with the associated key from the settings collection. |
|
Adds the specified key and value to the collection. |
|
Waits until the converter has been loaded by the Document Conversion Service or the time-out interval elapses. |
|
Waits until the Document Conversion Service is running or the time-out interval elapses. |
Read-only; A collection of IPNDocConvQueueItemError objects. This collection will be empty if the conversion succeeds. |
|
Read-only; A collection of IPNDocConvQueueItemFile objects. There will be one object for each file created. |
|
Read-only; A collection of IPNDocConvQueueItemImage objects. There will be one object for each page in each file created. |
|
Read-only; A collection of IPNDocConvQueueItemJob objects. There will be one object for each print job created by the conversion service. |
|
Read-only; A collection of IPNDocConvQueueItemMessage objects. There will be one object for each information message reported by the conversion service. This collection can be empty. |
|
Read-only; A collection of IPNDocConvQueueItemPage objects. There will be one object for each page in each file created by the conversion service. |
This event is fired each time a file we are creating is closed. |
|
This event is fired when the conversion process is complete for the source file. |
|
This event is fired each time a new image for a page is completed. |
|
This event is fired each time a single job for a file has completed printing. Some files create multiple jobs. |
|
This event is fired each time a new page in an output file is completed |
|
This event is fired each time a file name needs to be created but as it is easier to pass the desired output file name in the Convert method this event rarely needs to be handled. |
|
This event is fired when informational messages are logged by the conversion process. |
|
This event is fired each time a new output file is opened or created as part of the conversion process. |
|
This event is fired when an error occurs during the conversion process. |
|
This event is fired when the source file is received to be converted but before the conversion process is started |
|
This event is fired each time a new image for a page is created. |
|
This event is fired each time a single job for a file has started printing through the converters. Some files can create multiple jobs. |
|
This event is fired each time a new page in an output file is to be created |
