SignDoc SDK (.NET with exceptions)
5.0.0
|
Parameters for SignDocDocument.renderPageAsImage() and SignDocDocument.renderPageAsSignDocImage(). More...
Public Member Functions | |
SignDocRenderParameters () | |
Constructor. More... | |
SignDocRenderParameters (SignDocRenderParameters aSource) | |
Copy constructor. More... | |
~SignDocRenderParameters () | |
Destructor. More... | |
!SignDocRenderParameters () | |
Finalizer. More... | |
void | clear () |
Reset all parameters to their initial values. More... | |
void | setBoolean (string aName, bool aValue) |
Set a boolean parameter. More... | |
void | setInteger (string aName, int aValue) |
Set an integer parameter. More... | |
void | setNumber (string aName, double aValue) |
Set a floating-point number parameter. More... | |
void | setString (string aName, string aValue) |
Set a string parameter. More... | |
void | setString2 (string aName, string aName2, string aValue) |
Set a string parameter with two parameter names. More... | |
bool? | getBoolean (string aName) |
Get the value of a boolean parameter. More... | |
int? | getInteger (string aName) |
Get the value of an integer parameter. More... | |
double? | getNumber (string aName) |
Get the value of a floating-point number parameter. More... | |
string | getString (string aName) |
Get the value of a string parameter. More... | |
string | getString2 (string aName, string aName2) |
Get the value of a string parameter with two parameter names. More... | |
string | getErrorMessage () |
Get an error message for the last function call. More... | |
bool | equals (SignDocRenderParameters aRHS) |
Compare against another SignDocRenderParameters object. More... | |
Static Public Member Functions | |
static RenderParameterType | getType (string aName) |
Get the type of a parameter. More... | |
Parameters for SignDocDocument.renderPageAsImage() and SignDocDocument.renderPageAsSignDocImage().
Constructor.
SignDocRenderParameters | ( | SignDocRenderParameters | aSource | ) |
Copy constructor.
[in] | aSource | The object to be copied. |
Destructor.
Finalizer.
void clear | ( | ) |
Reset all parameters to their initial values.
bool equals | ( | SignDocRenderParameters | aRHS | ) |
Compare against another SignDocRenderParameters object.
[in] | aRHS | The object to compare against. |
bool? getBoolean | ( | string | aName | ) |
Get the value of a boolean parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
string getErrorMessage | ( | ) |
Get an error message for the last function call.
int? getInteger | ( | string | aName | ) |
Get the value of an integer parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
double? getNumber | ( | string | aName | ) |
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). |
string getString | ( | string | aName | ) |
Get the value of a string parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
string getString2 | ( | string | aName, |
string | aName2 | ||
) |
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). |
[in] | aName2 | The second name of the parameter (case-sensitive). |
|
static |
Get the type of a parameter.
[in] | aName | The name of the parameter (case-sensitive). |
void setBoolean | ( | string | aName, |
bool | aValue | ||
) |
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.
This function throws SignDocUnkownParameterException if aName is not the name of a boolean parameter.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
void setInteger | ( | string | aName, |
int | aValue | ||
) |
Set an integer parameter.
The following integer parameters are available:
This function throws SignDocUnkownParameterException if aName is not the name of an integer parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
void setNumber | ( | string | aName, |
double | aValue | ||
) |
Set a floating-point number parameter.
The following floating-point number parameters are available:
This function throws SignDocUnkownParameterException if aName is not the name of a floating-point number parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
void setString | ( | string | aName, |
string | aValue | ||
) |
Set a string parameter.
The following string parameters are available:
This function throws SignDocUnkownParameterException if aName is not the name of a string parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
void setString2 | ( | string | aName, |
string | aName2, | ||
string | aValue | ||
) |
Set a string parameter with two parameter names.
The following string parameters with two parameter names are available:
This function throws SignDocUnkownParameterException if aName is not the name of a string parameter with two parameter names, SignDocInvalidValueException if aValue is invalid.
[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. |