Foxit PDF SDK
fsdk.OFDRenderer Class Reference

Public Member Functions

def IsEmpty ()
 Check whether current object is empty or not. More...
 
def SetColorMode (color_mode)
 Set the color mode. More...
 
def SetContentFlag (content_flag)
 Set the content flag. More...
 
def StartRender (page, matrix)
 Start to render an OFD page. More...
 

Detailed Description

This class is used to render an OFD page to a bitmap. Please ensure fsdk.LibraryInitializeOFDEngine has been called successfully before using this class.

See also
fsdk.Library

Member Function Documentation

◆ IsEmpty()

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

◆ SetColorMode()

def fsdk.OFDRenderer.SetColorMode (   color_mode)

Set the color mode.

Parameters
[in]color_modeColor mode. Please refer to values starting from fsdk.OFDRendererE_ColorModeNormal and this should be one of these values. The default value is fsdk.OFDRendererE_ColorModeNormal .
Returns
None.

◆ SetContentFlag()

def fsdk.OFDRenderer.SetContentFlag (   content_flag)

Set the content flag.

Parameters
[in]content_flagContent flag. Please refer to values starting from fsdk.OFDRendererE_ContentFlagAllContent and this can be one or a combination of these values. The default value is fsdk.OFDRendererE_ContentFlagAllContent .
Returns
None.

◆ StartRender()

def fsdk.OFDRenderer.StartRender (   page,
  matrix 
)

Start to render an OFD page.

This function is used to start to render an OFD page.

Parameters
[in]pageAn OFD page object. It should not be an empty object.
[in]matrixA matrix for rendering the page, which is usually returned by function fsdk.OFDPage.GetDisplayMatrix .
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.