Each print job in the queue is handled as a PrintJob object which has methods and properties to work on each print job. The listing below shows the PrintJob methods and properties:
Summary: Method that sets the conversion profile by the supplied guid.
profileGuid: Specifies the guid of the profile to be used.
PDFCreator comes with a set of predefined profiles which have human-readable GUIDs. To set a profile via the GUID is more reliable, because the profile name may be changed by the user, while the GUID remains. Furthermore the names of the default profiles are translated and changed with the language.
GUID |
Description |
|---|---|
DefaultGuid |
Creates PDF files |
PdfaGuid |
Creates PDF/A files |
PrintGuid |
Sends output to a printer after conversion |
HighCompressionGuid |
PDFs with high compression images |
HighQualityGuid |
PDFs with high quality images |
JpegGuid |
Creates JPEG files |
PngGuid |
Creates PNG files |
TiffGuid |
Creates TIFF files |
Note
The GUID for every profile can be found in the registry in the details of each conversion profile.
Warning
If you delete a profile and create a new profile with the same name, the GUIDs will not match.
Summary: Method that sets the conversion profile by the supplied guid or name.
profileGuid: Specifies the guid or the name of the profile to be used.
Summary: Starts the actual conversion and saves the converted file to the location specified by path.
path: Includes the location and full name of the file.
Summary: Starts the actual conversion asynchronously and saves the converted file to the location specified by path.
path: Includes the location and full name of the file.
Summary: Set a conversion profile property using two strings: One for the name (e.g. PdfSettings.Security.Enable) and one for the value.
name: Name of the setting (see COM Interface Settings). This can include subproperties (e.g. PdfSettings.Security.Enable).
value: A string that can be parsed to the type.
Summary: Get a conversion profile property using its name.
Return value: The value of the property as a string.
Summary: Gives a reference to the files produced by the conversion. For further information see OutputFiles.
Return value: A reference to the output files.
Summary: Property, that gives a reference to a PrintJobInfo object for further information see PrintJobInfo. It allows to get more information on a PrintJob object such as PrintJob name, PrintJob author and more…
Summary: Event, that is fired, when the job was finished.
Summary: Property that returns true, if the conversion of the job quited otherwise it returns false.
Summary: Property that returns true, if the conversion of the job was successful otherwise it returns false.
Summary: Enable the given action and append it to the PDFCreator Workflow. actionSettingsName: The Action that you want to add, using its setting name (see COM Interface Settings).
Summary: Enable the given action and append it to the PDFCreator Workflow at a certain position. actionSettingsName: The Action that you want to add, using its setting name (see COM Interface Settings). addToPosition: The execution position it should be triggered at (first position is 0).
Summary: Disable an action and remove it from the PDFCreator Workflow. (Can also remove action added by the profile in app) actionSettingsName: The action that you want to remove using its setting name (see COM Interface Settings).
Summary: Get a property as list if it is a string list. Keep in mind that the list is just a copy and will not update with your changes. Use the SetProfileListSetting function to apply the value. propertyName: The name of the property you want to get as a list, using its setting name (see COM Interface Settings). Return value: Returns a copy of a setting as a string list.
Summary: Sets the property of a setting if it is a list of string. name: Name of the property you want to set, using its setting name (see COM Interface Settings). value: The list of string you want to write into the property.