SignDoc SDK (C++)
5.0.0
|
Parameters for SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage(). More...
#include <SignDocSDK-cpp.h>
Public Types | |
enum | Type { t_undefined = 0, t_boolean = 1, t_integer = 2, t_number = 3, t_string = 4, t_string2 = 6 } |
Return values of getType(). More... | |
Public Member Functions | |
SignDocRenderParameters () | |
Constructor. More... | |
SignDocRenderParameters (const SignDocRenderParameters &aSource) | |
Copy constructor. More... | |
~SignDocRenderParameters () | |
Destructor. More... | |
SignDocRenderParameters & | operator= (const SignDocRenderParameters &aSource) |
Assignment operator. More... | |
void | clear () |
Reset all parameters to their initial values. More... | |
ReturnCode | setBoolean (const std::string &aName, bool aValue) |
Set a boolean parameter. More... | |
ReturnCode | setInteger (const std::string &aName, int aValue) |
Set an integer parameter. More... | |
ReturnCode | setNumber (const std::string &aName, double aValue) |
Set a floating-point number parameter. More... | |
ReturnCode | setString (Encoding aEncoding, const std::string &aName, const std::string &aValue) |
Set a string parameter. More... | |
ReturnCode | setString2 (Encoding aEncoding, const std::string &aName, const std::string &aName2, const std::string &aValue) |
Set a string parameter with two parameter names. More... | |
ReturnCode | setString2Wide (const std::string &aName, const wchar_t *aName2, const std::string &aValue) |
Set a string parameter (with two parameter names, the second one being aa wide string). More... | |
const int * | getBoolean (const std::string &aName) const |
Get the value of a boolean parameter. More... | |
const int * | getInteger (const std::string &aName) const |
Get the value of an integer parameter. More... | |
const double * | getNumber (const std::string &aName) const |
Get the value of a floating-point number parameter. More... | |
const char * | getString (const std::string &aName) const |
Get the value of a string parameter. More... | |
const char * | getString2 (const std::string &aName, const std::string &aName2) const |
Get the value of a string parameter (with two parameter names). More... | |
bool | operator== (const SignDocRenderParameters &aRHS) const |
Compare against another SignDocRenderParameters object. More... | |
const char * | getErrorMessage (Encoding aEncoding) const |
Get an error message for the last function call. More... | |
const wchar_t * | getErrorMessageW () const |
Get an error message for the last function call. More... | |
SignDocRenderParameters (SIGNDOC_RenderParameters *aP) | |
Internal function. More... | |
SIGNDOC_RenderParameters * | getImpl () |
Internal function. More... | |
const SIGNDOC_RenderParameters * | getImpl () const |
Internal function. More... | |
void | setImpl (SIGNDOC_RenderParameters *aP) |
Internal function. More... | |
Static Public Member Functions | |
static Type | getType (const std::string &aName) |
Get the type of a parameter. More... | |
Parameters for SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage().
enum Type |
Return values of getType().
Enumerator | |
---|---|
t_undefined |
The specified parameter is not defined. |
t_boolean |
Boolean.
|
t_integer |
Integer.
|
t_number |
Floating-point number.
|
t_string |
String.
|
t_string2 |
String (with two parameter names).
|
|
inline |
Constructor.
|
inline |
Copy constructor.
[in] | aSource | The object to be copied. |
|
inline |
Destructor.
|
inline |
Internal function.
|
inline |
Reset all parameters to their initial values.
|
inline |
Get the value of a boolean parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
|
inline |
Get an error message for the last function call.
[in] | aEncoding | The encoding to be used for the error message. |
|
inline |
Get an error message for the last function call.
|
inline |
Internal function.
|
inline |
Internal function.
|
inline |
Get the value of an integer parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
|
inline |
Get the value of a floating-point number parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
|
inline |
Get the value of a string parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive, UTF-8). |
|
inline |
Get the value of a string parameter (with two parameter names).
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive, UTF-8). |
[in] | aName2 | The second name of the parameter (case-sensitive, UTF-8). |
|
inlinestatic |
Get the type of a parameter.
[in] | aName | The name of the parameter (case-sensitive). |
|
inline |
Assignment operator.
[in] | aSource | The source object. |
|
inline |
Compare against another SignDocRenderParameters object.
[in] | aRHS | The object to compare against. |
|
inline |
Set a boolean parameter.
The following boolean parameters are available:
AddDecorations: Enable rendering of decorations of signature fields of PDF documents. If true, an icon visualizing the signature status will be added to each signature field:
You might want to set boolean parameter "UseModificationState" to true to compute the signature state more thoroughly.
Enabling rendering of decorations can slow down SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage() substantially for PDF documents as each call will validate all the signatures of the page. Moreover, long term validation (LTV) is currently not supported by SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage(). Setting string parameter (with two parameter names) "DecorationState" might solve these problems.
It is recommended to display the status of signatures off-page rather than using this parameter, see SignDocDocument::getSignature().
For TIFF documents, this parameter is ignored; a red cross will be displayed in signature fields if the signature is broken.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
|
inline |
Internal function.
|
inline |
Set an integer parameter.
The following integer parameters are available:
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
|
inline |
Set a floating-point number parameter.
The following floating-point number parameters are available:
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
|
inline |
Set a string parameter.
The following string parameters are available:
[in] | aEncoding | The encoding used for aName and aValue. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. The encoding is specified by aEncoding. |
|
inline |
Set a string parameter with two parameter names.
The following string parameters with two parameter names are available:
[in] | aEncoding | The encoding used for aName2 and aValue. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aName2 | The second name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. The encoding is specified by aEncoding. |
|
inline |
Set a string parameter (with two parameter names, the second one being aa wide string).
See setString2() for the available parameters.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aName2 | The second name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter (UTF-8). |