Foxit PDF RDK
RenderPageTask Class Reference

Represents a task for render a page in a document with various settings. More...

Inheritance diagram for RenderPageTask:
Task NativeObjectWrapper

Public Member Functions

 constructor (renderInfo, cb)
 Constructor for the RenderPageTask class. More...
 
 setBitmapBuffer (buffer)
 Sets the bitmap buffer for the page render. More...
 
- Public Member Functions inherited from Task
 canCancel ()
 Checks if the task can be cancelled. More...
 
 cancel ()
 Cancels the task. Attempts to cancel the task if it is in a cancellable state.
 
 constructor ()
 Constructor for the Task class. Initializes a new instance of the Task.
 
 errorCode ()
 Gets the error code of the task. More...
 
 exeSuccess ()
 Checks if the task was executed successfully. More...
 
 extErrorCode ()
 Gets the extended error code of the task. More...
 
 finish ()
 Marks the task as finished. Completes the task and performs any necessary cleanup.
 
 getPriority ()
 Gets the current priority of the task. More...
 
 getStatus ()
 Gets the current status of the task. More...
 
 isCanceled ()
 Checks if the task has been cancelled. More...
 
 isModify ()
 Checks if the task has been modified. More...
 
 notify (result)
 Notifies about the result of the js funcion. More...
 
 prepare ()
 Prepares the task for execution. Performs any necessary setup before the task can be run.
 
 setErrorCode (error)
 Sets the error code for the task. More...
 
 setPriority (priority)
 Sets the priority of the task. More...
 
 setStatus (status)
 Sets the status of the task. More...
 
- Public Member Functions inherited from NativeObjectWrapper
 constructor (r)
 
 GetPointerAsNumber ()
 

Detailed Description

Represents a task for render a page in a document with various settings.

Examples
/Users/ec2-user/gitlab-runner/builds/E-xKdhDo/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

◆ constructor()

RenderPageTask.constructor ( renderInfo  ,
cb   
)

Constructor for the RenderPageTask class.

Parameters
{RenderPageModel}renderInfo - The settings data for the render page task.
{RenderPageTaskCallBack}cb - The callback to be invoked with the result of the render page task. Initializes a new instance of the RenderPageTask with the specified settings and callback.

◆ setBitmapBuffer()

RenderPageTask.setBitmapBuffer ( buffer  )

Sets the bitmap buffer for the page render.

Parameters
{ArrayBuffer}buffer - The buffer containing bitmap data to be used for render.