Foxit PDF SDK
|
Public Types | |
enum | ColorantType { ColorantType.e_ColorantTypeProcess = 0, ColorantType.e_ColorantTypeSpot = 1 } |
Enumeration for colorant type. More... | |
enum | ShowType { ShowType.e_ShowAll = 0, ShowType.e_ShowDeviceCMYK = 1, ShowType.e_ShowNotDeviceCMYK = 2, ShowType.e_ShowICCBasedCMYK = 3, ShowType.e_ShowSpotColor = 4, ShowType.e_ShowDeviceCMYKAndSpot = 5, ShowType.e_ShowNotDeviceCMYKOrSpot = 6, ShowType.e_ShowDeviceN = 7, ShowType.e_ShowCMYK = 8, ShowType.e_ShowRGB = 9, ShowType.e_ShowDeviceRGB = 10, ShowType.e_ShowICCBasedRGB = 11, ShowType.e_ShowGray = 12, ShowType.e_ShowDeviceGray = 13, ShowType.e_ShowCalGray = 14, ShowType.e_ShowCalibrated = 15, ShowType.e_ShowLab = 16, ShowType.e_ShowDevice = 17, ShowType.e_ShowImages = 18, ShowType.e_ShowSolidColor = 19, ShowType.e_ShowSmoothShades = 20, ShowType.e_ShowRegistrationColor = 21, ShowType.e_ShowText = 22, ShowType.e_ShowLineArt = 23 } |
Enumeration for show type. More... | |
Public Member Functions | |
OutputPreview (foxit.pdf.PDFDoc pdf_doc) | |
Constructor, with parameters. More... | |
OutputPreview (OutputPreview other) | |
Constructor, with another output preview object. More... | |
System.Drawing.Bitmap | GeneratePreviewBitmap (PDFPage page, Matrix2D matrix, Renderer renderer) |
Generate the output preview bitmap for a PDF page. More... | |
StringArray | GetPlates (OutputPreview.ColorantType colorant_type) |
Get Separations plates. More... | |
bool | IsChecked (string plate_name) |
Check whether a plate is checked or not. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
void | SetCheckStatus (string plate_name, bool to_check) |
Set the check status for a plate. More... | |
void | SetShowType (OutputPreview.ShowType show_type) |
Set show type. More... | |
void | SetSimulationProfile (string icc_profile_path) |
Set simulation ICC profile file path. More... | |
This class can be used to do output preview. Output preview is to preview color separations and test different color profiles. Before use this class, please ensure function common.Library.SetDefaultICCProfilesPath has been called successfully; otherwise unexpcted error or result may occur when this class is being used to do output preview.
|
strong |
|
strong |
Enumeration for show type.
Values of this enumeration should be used alone.
|
inline |
Constructor, with parameters.
[in] | pdf_doc | A valid PDF document object. |
|
inline |
Constructor, with another output preview object.
[in] | other | Another output preview object. |
|
inline |
Generate the output preview bitmap for a PDF page.
This function will render target PDF page with flags and options specified in input renderer and settings of current output preview object, and then return the final output preview bitmap. Rendering process in this function will not affect input renderer.
Please ensure function OutputPreview.SetSimulationProfile has been called successfully; otherwise this function will throw foxit.common.ErrorCode.e_ErrUnsupported .
[in] | page | A valid PDF page object. This PDF page should have been parsed. |
[in] | matrix | The transformation matrix used for rendering, which is usually returned by function PDFPage.GetDisplayMatrix . |
[in] | renderer | A valid renderer object. |
|
inline |
Get Separations plates.
If to get plates of process colorant type, please ensure function OutputPreview.SetSimulationProfile has been called successfully; otherwise no plate of process colorant type will be retrieved.
[in] | colorant_type | Colorant type. Please refer to values starting from foxit.pdf.OutputPreview.ColorantType.e_ColorantTypeProcess and this should be one of these values. |
|
inline |
Check whether a plate is checked or not.
For a newly constructed output preview object, all the plates are not checked.
[in] | plate_name | Plate name. This can be retrieved from the returned string array of function OutputPreview.GetPlates . |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Set the check status for a plate.
[in] | plate_name | Plate name. This can be retrieved from the returned string array of function OutputPreview.GetPlates . |
[in] | to_check | Check status: true means to check the plate, while false means not to check the plate. |
|
inline |
Set show type.
If no show type is set to current object, value foxit.pdf.OutputPreview.ShowType.e_ShowAll will be used by default when function OutputPreview.GeneratePreviewBitmap is called.
[in] | show_type | Show type. Please refer to values starting from foxit.pdf.OutputPreview.ShowType.e_ShowAll and this should be one of these values. |
|
inline |
Set simulation ICC profile file path.
If the color space of input ICC profile file is not one of RGB/Gray/CMYK, this function will throw foxit.common.ErrorCode.e_ErrUnsupported .
This function should be called successfully before calling function OutputPreview.GeneratePreviewBitmap .
[in] | icc_profile_path | File path for an ICC profile which is to be used as simulation profile for output preview. |