Foxit PDF SDK
fsdk.Renderer Class Reference

Public Member Functions

def ClearClips ()
 Clear the clipping rectangle set by function fsdk.Renderer.SetClipRect . More...
 
def EnableForPrint (is_render_for_print)
 Set the flag to decide whether to do rendering in print mode. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def RenderAnnot (annot, matrix)
 Render a specified annotation. More...
 
def RenderFormControls (page, matrix)
 Render form controls. More...
 
def RenderGraphicsObject (graphics_object, page, matrix)
 Render a graphics object. More...
 
def SetClearType (is_clear_type)
 Set the flag to decide whether to use ClearType-like anti-aliasing to render text objects. More...
 
def SetClipPathFill (clip_path, matrix, fill_mode)
 Set clipping path using filled region. More...
 
def SetClipPathStroke (clip_path, matrix, graph_state)
 Set clipping path using stroked region. More...
 
def SetClipRect (clip_rect)
 Set the clipping rectangle which will be used in subsequent rendering progress. More...
 
def SetColorMode (color_mode)
 Set color mode. More...
 
def SetForceDownSample (is_to_force_down_sample)
 Set the flag to decide whether to use down-sampling for image stretching. More...
 
def SetForceHalftone (is_to_force_halftone)
 Set the flag to decide whether to use halftone for image stretching. More...
 
def SetForegroundColor (foreground_color)
 Set foreground color for text, path or both when color mode is fsdk.RendererE_ColorModeForeground . More...
 
def SetForegroundColorMode (foreground_color_mode)
 Set rendering foreground color mode when color mode is fsdk.RendererE_ColorModeForeground . More...
 
def SetJPEGDownSample (is_jepg_down_sample)
 Set the flag to decide whether to use down-sampling for jpeg image. More...
 
def SetJPXDownSample (is_jpx_down_sample)
 Set the flag to decide whether to use down-sampling for jpx image. More...
 
def SetLayerContext (layer_context)
 Set layer context to render context handle. More...
 
def SetMappingModeColors (background_color, foreground_color)
 Set background color and foreground color when color mode is fsdk.OFDRendererE_ColorModeMappingGray or fsdk.OFDRendererE_ColorModeMapping . More...
 
def SetPrintTextAsGraphic (is_to_print_text_graphic)
 Set the flag to decide whether to print text as path or bitmap. More...
 
def SetPrintTextAsImage (is_to_print_text_image)
 Set the flag to decide whether to print text as image. More...
 
def SetRenderAnnotAppearanceType (ap_type)
 Set the annotation's appearance type for rendering. More...
 
def SetRenderAnnotsForThumbnail (is_render_annots_for_thumbnail)
 Set rendering flag to decide whether to render annotations in thumbnail mode or not. More...
 
def SetRenderContentFlags (render_content_flags)
 Set rendering flag to decide what content will be rendered. More...
 
def SetRenderEnhanceThinLines (is_render_enhance_thin_lines)
 Set the flag to decide whether to enhance thin lines. More...
 
def SetRenderFormField (is_render_formfield)
 Set the flag to decide whether to render form fields (except signature fields). More...
 
def SetRenderImageAntiAliasing (is_render_image_antialiasing)
 Set the flag to decide whether to draw image anti-aliasing. More...
 
def SetRenderLayer (is_render_one_layer)
 Set the flag to decide whether to render one layer or all available layers. More...
 
def SetRenderPathAntiAliasing (is_render_path_antialiasing)
 Set the flag to decide whether to draw path anti-aliasing. More...
 
def SetRenderPathFullCovered (is_render_path_full_covered)
 A special flag that can be applied to fill mode. More...
 
def SetRenderPathThinLine (is_render_path_thin_line)
 Set the flag to decide whether to draw path as thin line. More...
 
def SetRenderSignature (is_render_signature)
 Set the flag to decide whether to render signatures or not. More...
 
def SetRenderSignatureState (is_render_signature_state)
 Set the flag to decide whether to draw the signature state on the signature. More...
 
def SetRenderTextAntiAliasing (is_render_text_antialiasing)
 Set the flag to decide whether to draw text anti-aliasing. More...
 
def SetScreenDPIScale (scale)
 Set the screen DPI scaling factor for rendering. More...
 
def StartQuickRender (page, matrix, pause)
 Start to quickly render a PDF page, mainly for thumbnail purpose. More...
 
def StartRender (page, matrix, pause)
 Start to render a PDF page. More...
 
def StartRenderBitmap (bitmap, matrix, clip_rect, interpolation, pause)
 Start to render a bitmap. More...
 
def StartRenderReflowPage (reflow_page, matrix, pause)
 Start to render a reflow page. More...
 
def StartRenderXFAPage (xfa_page_view, matrix, is_highlight, pause)
 Start to render an XFA page. More...
 

Detailed Description

PDF renderer is a graphics engine and is used to render page to a bitmap or a platform device context. This class can be constructed with a bitmap, or a device object. It offers functions to set rendering options/flags, and do rendering. In this class, there are several ways to do rendering:

Widget annotation is always associated with form field and form control in Foxit PDF SDK. For how to render widget annotations, here is a recommended flow:

  • After loading a PDF page, first render the page and all annotations in this page (including widget annotations).

  • Then, if user uses fsdk.Filler object to fill the form, user should use function fsdk.Filler.Render to render the focused form control instead of using function fsdk.Renderer.RenderAnnot .

See also
fsdk.Filler

Member Function Documentation

◆ ClearClips()

def fsdk.Renderer.ClearClips ( )

Clear the clipping rectangle set by function fsdk.Renderer.SetClipRect .

Returns
None.

◆ EnableForPrint()

def fsdk.Renderer.EnableForPrint (   is_render_for_print)

Set the flag to decide whether to do rendering in print mode.

Please ensure this rendering flag is set as expected when current renderer is to used for printing. For rendering annotations, if this flag is set to be true, Foxit PDF SDK will only render annotations which have annotation flag fsdk.AnnotE_FlagPrint .
If this function is not called for current renderer object yet, default value false will be used.

Parameters
[in]is_render_for_printtrue means to render in print mode, while false means to render not in print mode.
Returns
None.

◆ IsEmpty()

def fsdk.Renderer.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.

◆ RenderAnnot()

def fsdk.Renderer.RenderAnnot (   annot,
  matrix 
)

Render a specified annotation.

When this function is called, rendering flag (set by function fsdk.Renderer.SetRenderContentFlags or by default) will be ignored.

Parameters
[in]annotAn annotation object to be rendered. If input annot is a pop-up annotation, this function will not render it and will return false.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.PDFPage.GetDisplayMatrix .
Returns
true means success, while false means failure.

◆ RenderFormControls()

def fsdk.Renderer.RenderFormControls (   page,
  matrix 
)

Render form controls.

When this function is called, rendering flag (set by function fsdk.Renderer.SetRenderContentFlags or by default) will be ignored.

Parameters
[in]pageA valid PDF page. If input page is invalid, this function do nothing and return false directly.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.PDFPage.GetDisplayMatrix .
Returns
true means success, while false means failure.

◆ RenderGraphicsObject()

def fsdk.Renderer.RenderGraphicsObject (   graphics_object,
  page,
  matrix 
)

Render a graphics object.

When this function is called, rendering flag (set by function fsdk.Renderer.SetRenderContentFlags or by default) will be ignored.

Parameters
[in]graphics_objectA valid PDF graphics object to be rendered.
[in]pageA valid PDF page. Parameter graphics_object belongs to this PDF page.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.PDFPage.GetDisplayMatrix .
Returns
true means success, while false means failure.

◆ SetClearType()

def fsdk.Renderer.SetClearType (   is_clear_type)

Set the flag to decide whether to use ClearType-like anti-aliasing to render text objects.

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

Parameters
[in]is_clear_typetrue means to use ClearType-like anti-aliasing to render text objects. false means not to use ClearType-like anti-aliasing to render text objects.
Returns
None.

◆ SetClipPathFill()

def fsdk.Renderer.SetClipPathFill (   clip_path,
  matrix,
  fill_mode 
)

Set clipping path using filled region.

Parameters
[in]clip_pathA clipping path.
[in]matrixThe transformation matrix used for clipping.
[in]fill_modeFill mode. It should be value or .
Returns
None.

◆ SetClipPathStroke()

def fsdk.Renderer.SetClipPathStroke (   clip_path,
  matrix,
  graph_state 
)

Set clipping path using stroked region.

Parameters
[in]clip_pathA clipping path.
[in]matrixThe transformation matrix used for clipping.
[in]graph_stateA valid graph state, for pen attributes. If this is null, Foxit PDF SDK will use a graph state object with default constructor. Default value: null.
Returns
None.

◆ SetClipRect()

def fsdk.Renderer.SetClipRect (   clip_rect)

Set the clipping rectangle which will be used in subsequent rendering progress.

Parameters
[in]clip_rectA clipping rectangle. If it is null, that means not to use clipping rectangle in subsequent rendering progress.
Returns
None.

◆ SetColorMode()

def fsdk.Renderer.SetColorMode (   color_mode)

Set color mode.

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

Parameters
[in]color_modeColor mode value. It should be one of following values:
Returns
None.

◆ SetForceDownSample()

def fsdk.Renderer.SetForceDownSample (   is_to_force_down_sample)

Set the flag to decide whether to use down-sampling for image stretching.

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

Parameters
[in]is_to_force_down_sampletrue means to use down-sampling for image stretching. false means not to use down-sampling for image stretching.
Returns
None.

◆ SetForceHalftone()

def fsdk.Renderer.SetForceHalftone (   is_to_force_halftone)

Set the flag to decide whether to use halftone for image stretching.

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

Parameters
[in]is_to_force_halftonetrue means to use halftone for image stretching. false means not to use halftone for image stretching.
Returns
None.

◆ SetForegroundColor()

def fsdk.Renderer.SetForegroundColor (   foreground_color)

Set foreground color for text, path or both when color mode is fsdk.RendererE_ColorModeForeground .

The foreground color for text, path, or both is determined by the foreground color mode set by the function fsdk.Renderer.SetForegroundColorMode .

Parameters
[in]foreground_colorThe foreground color for text, path, or both. Format: 0xAARRGGBB.
Returns
None.

◆ SetForegroundColorMode()

def fsdk.Renderer.SetForegroundColorMode (   foreground_color_mode)

Set rendering foreground color mode when color mode is fsdk.RendererE_ColorModeForeground .

If this function is not called, default value (fsdk.RendererE_ColorModeForegroundText | fsdk.RendererE_ColorModeForegroundPath | fsdk.RendererE_ColorModeForegroundBlackText | fsdk.RendererE_ColorModeForegroundBlackPath ) will be used.

Parameters
[in]foreground_color_modeRendering foreground color mode. Please refer to values starting from fsdk.RendererE_ColorModeForegroundText and this should be one or a combination of these values.
Returns
None.

◆ SetJPEGDownSample()

def fsdk.Renderer.SetJPEGDownSample (   is_jepg_down_sample)

Set the flag to decide whether to use down-sampling for jpeg image.

Whether to use down-sampling for jpeg image or not will affect rendering result for a PDF page. When current function is called successfully, user should called function fsdk.PDFPage.ClearRenderCache for a PDF page (which has been rendered at least once) before rendering the PDF page again.
If this function is not called, default value true will be used.

Parameters
[in]is_jepg_down_sampletrue means to use down-sampling for jpeg image. false means not to use down-sampling for jpeg image.
Returns
None.

◆ SetJPXDownSample()

def fsdk.Renderer.SetJPXDownSample (   is_jpx_down_sample)

Set the flag to decide whether to use down-sampling for jpx image.

Whether to use down-sampling for jpx image or not will affect rendering result for a PDF page. When current function is called successfully, user should called function fsdk.PDFPage.ClearRenderCache for a PDF page (which has been rendered at least once) before rendering the PDF page again.
If this function is not called, default value true will be used.

Parameters
[in]is_jpx_down_sampletrue means to use down-sampling for jpx image. false means not to use down-sampling for jpx image.
Returns
None.

◆ SetLayerContext()

def fsdk.Renderer.SetLayerContext (   layer_context)

Set layer context to render context handle.

In order to render one layer when PDF page's contents is rendered on a rendering context, user should call this function to set the layer context to render context.

Parameters
[in]layer_contextA layer context object.
Returns
None.

◆ SetMappingModeColors()

def fsdk.Renderer.SetMappingModeColors (   background_color,
  foreground_color 
)

Set background color and foreground color when color mode is fsdk.OFDRendererE_ColorModeMappingGray or fsdk.OFDRendererE_ColorModeMapping .

Parameters
[in]background_colorThe background color. Format: 0xAARRGGBB.
[in]foreground_colorThe foreground color. Format: 0xAARRGGBB.
Returns
None.

◆ SetPrintTextAsGraphic()

def fsdk.Renderer.SetPrintTextAsGraphic (   is_to_print_text_graphic)

Set the flag to decide whether to print text as path or bitmap.

When this flag is true, Foxit PDF SDK will render text in different way: if font size is greater than 50, print text as path; otherwise, print text as bitmap.
If this function is not called, default value false will be used.

Parameters
[in]is_to_print_text_graphictrue means to print text as path or bitmap. false means not to print text as path or bitmap.
Returns
None.

◆ SetPrintTextAsImage()

def fsdk.Renderer.SetPrintTextAsImage (   is_to_print_text_image)

Set the flag to decide whether to print text as image.

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

Parameters
[in]is_to_print_text_imagetrue means to print text as image. false means not to print text as image.
Returns
None.

◆ SetRenderAnnotAppearanceType()

def fsdk.Renderer.SetRenderAnnotAppearanceType (   ap_type)

Set the annotation's appearance type for rendering.

Parameters
[in]ap_typeType of annotation's appearance. Please refer to values starting from fsdk.AnnotE_AppearanceTypeNormal and this should be one of these values.
Returns
None.

◆ SetRenderAnnotsForThumbnail()

def fsdk.Renderer.SetRenderAnnotsForThumbnail (   is_render_annots_for_thumbnail)

Set rendering flag to decide whether to render annotations in thumbnail mode or not.

In thumbnail mode, the flags of annotations, "NoZoom" and "NoRotate", will be ignored. This rendering flag is available only when flag fsdk.RendererE_RenderAnnot is used for rendering or function fsdk.Renderer.RenderAnnot is called. Please refer to function fsdk.Renderer.SetRenderContentFlags about setting flag fsdk.RendererE_RenderAnnot .
If this function is not called, default value false will be used when this rendering flag is available.

Parameters
[in]is_render_annots_for_thumbnailtrue means to render annotations in thumbnail mode. false means not to render annotations in thumbnail mode.
Returns
None.

◆ SetRenderContentFlags()

def fsdk.Renderer.SetRenderContentFlags (   render_content_flags)

Set rendering flag to decide what content will be rendered.

If this function is not called, default value (fsdk.RendererE_RenderPage | fsdk.RendererE_RenderAnnot ) will be used.

Parameters
[in]render_content_flagsRendering content flags. Please refer to values starting from fsdk.RendererE_RenderPage and this should be one or a combination of these values. The fsdk.RendererE_RenderHighlight can not be combined with fsdk.RendererE_RenderExceptHighlight .
Returns
None.

◆ SetRenderEnhanceThinLines()

def fsdk.Renderer.SetRenderEnhanceThinLines (   is_render_enhance_thin_lines)

Set the flag to decide whether to enhance thin lines.

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

Parameters
[in]is_render_enhance_thin_linestrue means to draw zero width lines with a thicker path so they are more visible than the default single pixel.
false means to draw zero width lines with a single pixel width.
Returns
None.

◆ SetRenderFormField()

def fsdk.Renderer.SetRenderFormField (   is_render_formfield)

Set the flag to decide whether to render form fields (except signature fields).

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

Parameters
[in]is_render_formfieldtrue means to render form fields (except signature fields). false means not to render form fields (except signature fields).
Returns
None.

◆ SetRenderImageAntiAliasing()

def fsdk.Renderer.SetRenderImageAntiAliasing (   is_render_image_antialiasing)

Set the flag to decide whether to draw image anti-aliasing.

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

Parameters
[in]is_render_image_antialiasingtrue means to draw image anti-aliasing, and the effect would be similar to values defined in enum class InterpolationFlag. false means to draw image aliasing.
Returns
None.

◆ SetRenderLayer()

def fsdk.Renderer.SetRenderLayer (   is_render_one_layer)

Set the flag to decide whether to render one layer or all available layers.

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

Parameters
[in]is_render_one_layertrue means to render one layer. false means to render all available layers.
Returns
None.

◆ SetRenderPathAntiAliasing()

def fsdk.Renderer.SetRenderPathAntiAliasing (   is_render_path_antialiasing)

Set the flag to decide whether to draw path anti-aliasing.

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

Parameters
[in]is_render_path_antialiasingtrue means to draw path anti-aliasing. false means to draw path aliasing.
Returns
None.

◆ SetRenderPathFullCovered()

def fsdk.Renderer.SetRenderPathFullCovered (   is_render_path_full_covered)

A special flag that can be applied to fill mode.

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

Parameters
[in]is_render_path_full_coveredtrue means that all pixels partially covered by the path will be fully painted, while false means not.
Returns
None.

◆ SetRenderPathThinLine()

def fsdk.Renderer.SetRenderPathThinLine (   is_render_path_thin_line)

Set the flag to decide whether to draw path as thin line.

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

Parameters
[in]is_render_path_thin_linetrue means to draw path as thin line. false means not to draw path as thin line.
Returns
None.

◆ SetRenderSignature()

def fsdk.Renderer.SetRenderSignature (   is_render_signature)

Set the flag to decide whether to render signatures or not.

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

Parameters
[in]is_render_signaturetrue means to render signatures. false means not to render signatures.
Returns
None.

◆ SetRenderSignatureState()

def fsdk.Renderer.SetRenderSignatureState (   is_render_signature_state)

Set the flag to decide whether to draw the signature state on the signature.

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

Parameters
[in]is_render_signature_statetrue means to draw the signature state on the signature, while false means not.

◆ SetRenderTextAntiAliasing()

def fsdk.Renderer.SetRenderTextAntiAliasing (   is_render_text_antialiasing)

Set the flag to decide whether to draw text anti-aliasing.

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

Parameters
[in]is_render_text_antialiasingtrue means to draw text anti-aliasing. false means to draw text aliasing.
Returns
None.

◆ SetScreenDPIScale()

def fsdk.Renderer.SetScreenDPIScale (   scale)

Set the screen DPI scaling factor for rendering.

Set the screen DPI scaling scale to adapt to different DPI conditions. This value should typically match the system- reported scaling factor (e.g., 1.25 for 125% scaling in display settings) to ensure proper rendering alignment with the physical display characteristics.

Parameters
[in]scaleThe scale of curren screen DPI(1.0 = 100% native DPI, 2.0 = 200%, etc.). Must be greater than 0 and should generally correspond to the system's recommended scaling factor.
Note
Currently, this screen DPI scaling factor only affects the annotations.
Returns
None.

◆ StartQuickRender()

def fsdk.Renderer.StartQuickRender (   page,
  matrix,
  pause 
)

Start to quickly render a PDF page, mainly for thumbnail purpose.

This function is mainly used for render a page for thumbnail purpose. The rendered content will not be completed: all the annotations will be ignored, event if flag fsdk.RendererE_RenderAnnot is set by function fsdk.Renderer.SetRenderContentFlags ; text content will become blurred and will be replace by pixel point.
It may still take a long time to do this quick rendering when page has complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]pageA valid PDF page. It should have been parsed.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.PDFPage.GetDisplayMatrix .
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ StartRender()

def fsdk.Renderer.StartRender (   page,
  matrix,
  pause 
)

Start to render a PDF page.

It may take a long time to render a PDF page with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.
Widget annotation is always associated with form field and form control in Foxit PDF SDK. For how to render widget annotations, here is a recommended flow:

  • After loading a PDF page, first render the page and all annotations in this page (including widget annotations).

  • Then, if user uses fsdk.Filler object to fill the form, user should use function fsdk.Filler.Render to render the focused form control instead of using function fsdk.Renderer.RenderAnnot .

Parameters
[in]pageA valid PDF page. If only to render annotations (that means only fsdk.RendererE_RenderAnnot is set by function fsdk.Renderer.SetRenderContentFlags ), there is no need to parse the input page; otherwise the input page should have been parsed.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.PDFPage.GetDisplayMatrix .
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ StartRenderBitmap()

def fsdk.Renderer.StartRenderBitmap (   bitmap,
  matrix,
  clip_rect,
  interpolation,
  pause 
)

Start to render a bitmap.

It may take a long time to render a bitmap with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]bitmapA valid bitmap. User should ensure the bitmap to keep valid until current rendering process is finished.
[in]matrixThe transformation matrix used for rendering. This matrix is used as image matrix:
assume that h is image height, w is image width, and then matrix [w 0 0 h 0 0] will produce an identical image.
[in]clip_rectClip rectangle for the rendering device. This can be null. Default value: null.
[in]interpolationBitmap interpolation flags. Please refer to values starting from fsdk.BitmapE_Downsample and this can be one or a combination of these values. If not specify any flag, please use 0. Default value: 0.
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

It may take a long time to render a bitmap with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]bitmapA valid bitmap. User should ensure the bitmap to keep valid until current rendering process is finished.
[in]matrixThe transformation matrix used for rendering. This matrix is used as image matrix:
assume that h is image height, w is image width, and then matrix [w 0 0 h 0 0] will produce an identical image.
[in]clip_rectClip rectangle for the rendering device. This can be null.
[in]interpolationBitmap interpolation flags. Please refer to values starting from fsdk.BitmapE_Downsample and this can be one or a combination of these values. If not specify any flag, please use 0.
[in]alphaBitmap alpha represents transparency (0 = fully transparent, 255 = fully opaque). Valid range: from 0 to 255.
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ StartRenderReflowPage()

def fsdk.Renderer.StartRenderReflowPage (   reflow_page,
  matrix,
  pause 
)

Start to render a reflow page.

It may take a long time to render a reflow page with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]reflow_pageA valid reflow page. It should have been parsed.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.ReflowPage.GetDisplayMatrix .
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user. Default value:null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.

◆ StartRenderXFAPage()

def fsdk.Renderer.StartRenderXFAPage (   xfa_page_view,
  matrix,
  is_highlight,
  pause 
)

Start to render an XFA page.

It will take a long time to render an XFA page with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]xfa_page_viewA valid XFA page.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function fsdk.XFAPage.GetDisplayMatrix .
[in]is_highlighttrue means to highlight XFA widgets, and false means not to highlight XFA widgets.
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
Returns
A progressive object. Please check the rate of current progress by function fsdk.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function fsdk.Progressive.Continue to continue the progress until the progress is finished.