Foxit PDF SDK
fsdk.OutputPreview Class Reference

Public Member Functions

def EnableSimulateOverprint (is_to_simulate_overprint)
 Set the flag to decide whether to enable simulate overprint. More...
 
def GeneratePreviewBitmap (page, matrix, renderer)
 Generate the output preview bitmap for a PDF page. More...
 
def GetPlates (colorant_type)
 Get Separations plates. More...
 
def GetSpotPlateColor (plate_name)
 Get the color value of a plate. More...
 
def IsChecked (plate_name)
 Check whether a plate is checked or not. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def SetCheckStatus (plate_name, to_check)
 Set the check status for a plate. More...
 
def SetShowType (show_type)
 Set show type. More...
 
def SetSimulationProfile (icc_profile_path)
 Set simulation ICC profile file path. More...
 

Detailed Description

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 fsdk.LibrarySetDefaultICCProfilesPath has been called successfully; otherwise unexpcted error or result may occur when this class is being used to do output preview. Currently, this feature is not supported on the Linux ARM and Mac ARM platform.

Member Function Documentation

◆ EnableSimulateOverprint()

def fsdk.OutputPreview.EnableSimulateOverprint (   is_to_simulate_overprint)

Set the flag to decide whether to enable simulate overprint.

If this function is not called, default value true will be used.

Parameters
[in]is_to_simulate_overprinttrue means to simulate overprinting. false means not to simulate overprinting.
Returns
None.

◆ GeneratePreviewBitmap()

def fsdk.OutputPreview.GeneratePreviewBitmap (   page,
  matrix,
  renderer 
)

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 fsdk.OutputPreview.SetSimulationProfile has been called successfully; otherwise this function will throw fsdk.E_ErrUnsupported .

Parameters
[in]pageA valid PDF page object. This PDF page should have been parsed.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.PDFPage.GetDisplayMatrix .
[in]rendererA valid renderer object.
Returns
A bitmap which represents the output preview result.

◆ GetPlates()

def fsdk.OutputPreview.GetPlates (   colorant_type)

Get Separations plates.

If to get plates of process colorant type, please ensure function fsdk.OutputPreview.SetSimulationProfile has been called successfully; otherwise no plate of process colorant type will be retrieved.

Parameters
[in]colorant_typeColorant type. Please refer to values starting from fsdk.OutputPreviewE_ColorantTypeProcess and this should be one of these values.
Returns
A string array which represents plate names.

◆ GetSpotPlateColor()

def fsdk.OutputPreview.GetSpotPlateColor (   plate_name)

Get the color value of a plate.

This function is only useful for a plate in spot colorant type.

Parameters
[in]plate_namePlate name. This can be retrieved form the returned string array of function fsdk.OutputPreview.GetPlates .
Returns
RGB color of the specified plate.

◆ IsChecked()

def fsdk.OutputPreview.IsChecked (   plate_name)

Check whether a plate is checked or not.

For a newly constructed output preview object, all the plates are not checked.

Parameters
[in]plate_namePlate name. This can be retrieved from the returned string array of function fsdk.OutputPreview.GetPlates .
Returns
true means the plate is checked, while false means the plate is not checked.

◆ IsEmpty()

def fsdk.OutputPreview.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ SetCheckStatus()

def fsdk.OutputPreview.SetCheckStatus (   plate_name,
  to_check 
)

Set the check status for a plate.

Parameters
[in]plate_namePlate name. This can be retrieved from the returned string array of function fsdk.OutputPreview.GetPlates .
[in]to_checkCheck status: true means to check the plate, while false means not to check the plate.
Returns
None.

◆ SetShowType()

def fsdk.OutputPreview.SetShowType (   show_type)

Set show type.

If no show type is set to current object, value fsdk.OutputPreviewE_ShowAll will be used by default when function fsdk.OutputPreview.GeneratePreviewBitmap is called.

Parameters
[in]show_typeShow type. Please refer to values starting from fsdk.OutputPreviewE_ShowAll and this should be one of these values.
Returns
None.

◆ SetSimulationProfile()

def fsdk.OutputPreview.SetSimulationProfile (   icc_profile_path)

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 fsdk.E_ErrUnsupported .
This function should be called successfully before calling function fsdk.OutputPreview.GeneratePreviewBitmap .

Parameters
[in]icc_profile_pathFile path for an ICC profile which is to be used as simulation profile for output preview.
Returns
None.