Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Declaration

...

HRESULT _stdcall ViewDocOnDevice([in] long startPage, [in] VARIANT_BOOL showSignButton, [out, retval] VARIANT_BOOL* result); 


Description

Use this function to show the document page on the connected signature device. This function is only supported by devices with colour display and it's not working with Black&White devices.

The function ViewDocOnDeviceDefaultZoom is an extended version of ViewDocOnDevice.

Image Modified

Important:

Be sure to call LoadDoc before calling this function! You also need to link the DeviceAPI to the SignAPI (see InitDeviceDLL / SignatureDevice ) and forward the ButtonEvents from DeviceAPI to SignAPI (OnDeviceLCDButtonHandler).

...


Arguments

ArgumentDescription
startPageThe number of the page, which should be shown first
showSignButton

Use this option to enable the Sign Now button on the signature device while using the DocumentViewing mode. This button can be used to start the signing mode directly from the device and is currently only available on Colour and Brilliance sign pads.

...


Return value

Returns False if the document viewing mode could not be started, otherwise the return value is True

...

C# sample

Code Block
languagecsharpc#
themeConfluence
titleAddSignature
linenumberstrue
// Show Document on the Device (Colour, Comfort and Flawless)

 
SignAPIv4.LoadDoc(@"c:\test\demo.pdf");
                
int page = 1;
bool signButton = true; 	// works only for ColourPad
 
bool status= SignAPIv4.ViewDocOnDevice(page, signButton);

 

...