SigBackgroundHeight Property

The height of the background image in pixels.

Syntax

 pdfsigner.getSigBackgroundHeight([callback])
 pdfsigner.setSigBackgroundHeight( sigBackgroundHeight, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSigBackgroundHeight([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSigBackgroundHeight([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The height of the background image in pixels.

It is important that this property matches the exact size of the image when custom background is used.

This property is not available at design time.

Data Type

Integer