SignDoc SDK (.NET without exceptions)
5.0.0
|
Parameters for saving images, converting images to bi-level images, and rendering biometric signatures as images. More...
Public Member Functions | |
~SignDocImageParameters () | |
Destructor. More... | |
!SignDocImageParameters () | |
Finalizer. More... | |
SignDocImageParameters () | |
Constructor. More... | |
SignDocImageParameters (SignDocImageParameters aSource) | |
Copy constructor. More... | |
void | clear () |
Unset all parameters. More... | |
void | setBoolean (out ReturnCode aReturnCode, string aName, bool aValue) |
Set a boolean parameter. More... | |
void | setInteger (out ReturnCode aReturnCode, string aName, int aValue) |
Set an integer parameter. More... | |
void | setNumber (out ReturnCode aReturnCode, string aName, double aValue) |
Set a floating-point number parameter. More... | |
void | setString (out ReturnCode aReturnCode, string aName, string aValue) |
Set a string parameter. More... | |
void | setColor (out ReturnCode aReturnCode, string aName, SignDocColor aValue) |
Set a color parameter. 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... | |
SignDocColor | getColor (string aName) |
Get the value of a color parameter. More... | |
string | getErrorMessage () |
Get an error message for the last function call. More... | |
Static Public Member Functions | |
static ImageParameterType | getType (string aName) |
Get the type of a parameter. More... | |
Parameters for saving images, converting images to bi-level images, and rendering biometric signatures as images.
In the descriptions of a parameter, the functions that make use of that parameter are indicated by these letters in square brackets:
Parameters for selecting the image format:
Parameters for conversion to bi-level black and white:
Parameters for configuring the size of the image:
Parameters for tuning the rendering of signatures:
Parameters for adding a cross:
The "raw" format stores the pixels only, without any header or other information. Therefore, the aOutput parameter (of type SignDocRenderOutput) of SignDocSignatureData.renderAsImage() is mandatory. The following paragraphs describe the available raw formats.
If integer parameter "BitsPerComponent" is 1, integer parameter "Components" must be 1 and 8 pixels will be stored per byte. The left-most pixel is stored in the most significant bit (0x80). Padding bits are added such that each row occupies an integral number of bytes. The interpretation of the values of the bits depends on boolean parameters "BlackIsZero" and "WhiteIsZero".
If integer parameter "BitsPerComponent" is 8 and integer parameter "Components" is 1, one byte per pixel (usually the palette index) will be stored.
If integer parameter "BitsPerComponent" is 8 and integer parameter "Components" is 3, three bytes per pixel will be stored: red, green, and blue. The value 0 is used for off, the value 0xff is used for on. The pixel format can be changed by setting string parameter "PixelFormat".
Depending on boolean parameter "BottomUp", the raw image begins with the left-most pixel of the top row (false) or with the left-most pixel of the bottom row (true).
Destructor.
Finalizer.
Constructor.
No parameters will be set.
SignDocImageParameters | ( | SignDocImageParameters | aSource | ) |
Copy constructor.
[in] | aSource | The object to be copied. |
void clear | ( | ) |
Unset all parameters.
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). |
SignDocColor getColor | ( | string | aName | ) |
Get the value of a color 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). |
|
static |
Get the type of a parameter.
[in] | aName | The name of the parameter (case-sensitive). |
void setBoolean | ( | out ReturnCode | aReturnCode, |
string | aName, | ||
bool | aValue | ||
) |
Set a boolean parameter.
The following boolean parameters are available:
[out] | aReturnCode | The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter 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 setColor | ( | out ReturnCode | aReturnCode, |
string | aName, | ||
SignDocColor | aValue | ||
) |
Set a color parameter.
The following color parameters are available:
[out] | aReturnCode | The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of a color parameter, ReturnCode.InvalidValue if aValue is invalid. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
void setInteger | ( | out ReturnCode | aReturnCode, |
string | aName, | ||
int | aValue | ||
) |
Set an integer parameter.
The following integer parameters are available:
[out] | aReturnCode | The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of an integer parameter, ReturnCode.InvalidValue if aValue is invalid. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
void setNumber | ( | out ReturnCode | aReturnCode, |
string | aName, | ||
double | aValue | ||
) |
Set a floating-point number parameter.
The following floating-point number parameters are available:
[out] | aReturnCode | The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of a floating-point number parameter, ReturnCode.InvalidValue if aValue is invalid. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
void setString | ( | out ReturnCode | aReturnCode, |
string | aName, | ||
string | aValue | ||
) |
Set a string parameter.
The following string parameters are available:
[out] | aReturnCode | The return code, ReturnCode.OK if successful, ReturnCode.UnknownParameter if aName is not the name of a string parameter, ReturnCode.InvalidValue if aValue is invalid. |
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |