Actions and parameters for SignDocImage.clean().
More...
Actions and parameters for SignDocImage.clean().
Constructor.
No actions will be set.
Copy constructor.
- Parameters
-
[in] | aSource | The object to be copied. |
void add |
( |
out ReturnCode |
aReturnCode, |
|
|
string |
aName |
|
) |
| |
Add an action without parameter.
The following actions without parameter are available:
- cleanDate: Remove handwritten text from the signature image and crop, see SignDocImage.cleanDate(). (Equivalent SPCleanDateEnable parameter: SPCleanDateEnable.)
- cleanLines: Remove horizontal and vertical lines, see SignDocImage.cleanLines(). (Equivalent SPCleanDateEnable parameter: SPCleanLineEnable.)
- cleanSignature: Clean signature image and crop, see SignDocImage.cleanSignature(). (Equivalent SPCleanDateEnable parameter: SPCleanSignatureEnable.)
- convertToBiLevel: Convert the image to bi-level black and white, see SignDocImage.convertToBiLevel(). (Equivalent SPCleanDateEnable parameter: SPBinarizeEnable.)
- convertToGrayscale: Convert the image to 8-bit grayscale, see SignDocImage.convertToGrayscale().
- convertToTrueColor: Convert the image to 24-bit RGB, see SignDocImage.convertToTrueColor().
- crop: Crop the image to the rectangle specified by these actions with integer parameter: "cropLeft", "cropHeight", "cropTop", "cropWidth". Default values will be used for missing parameters. After performing this action, those four parameters will be unset. See SignDocImage.crop(). Example: to remove the top 100 rows of pixels, call addInteger("cropTop",100) followed by add("crop"). (Equivalent SignWare SPCleanParameter parameter: SPCutRegionEnable.)
- mirrorX: Mirror along the vertical axis (flip horizontally), see SignDocImage.mirrorX(). (Equivalent SPCleanDateEnable parameters: SPMirrorAxes, SPMirrorEnable.)
- mirrorY: Mirror along the horizontal axis (flip vertically), see SignDocImage.mirrorY(). (Equivalent SPCleanDateEnable parameters: SPMirrorAxes, SPMirrorEnable.)
- removeMargins: Remove white margins ignoring single black pixels, see SignDocImage.removeMargins(). (Equivalent SPCleanDateEnable parameter: SPCutSignatureRegionEnable.)
- Parameters
-
[out] | aReturnCode | The return code, ReturnCode.OK iff successful. |
[in] | aName | The name of the action (case-sensitive). |
- See also
- addBoolean(), addInteger(), addNumber(), getBooleanAt()
void addBoolean |
( |
out ReturnCode |
aReturnCode, |
|
|
string |
aName, |
|
|
bool |
aValue |
|
) |
| |
Add an action with a boolean parameter.
The following action with boolean parameter is available:
- invert: invert the image, see SignDocImage.invert(). The value is false to invert the image unconditionally, true to invert the image only if more than half the pixels have brightness (0 through 255) less than 128. (Equivalent SPCleanDateEnable parameters: SPInvertEnable, SPInvertFlags.)
- Parameters
-
[out] | aReturnCode | The return code, ReturnCode.OK iff successful. |
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
- See also
- add(), addInteger(), addNumber(), getBooleanAt()
void addInteger |
( |
out ReturnCode |
aReturnCode, |
|
|
string |
aName, |
|
|
int |
aValue |
|
) |
| |
Add an action with an integer parameter.
The following actions with integer parameter are available:
- cropHeight: set the height of the rectangle that will be preserved by the next "crop" action. The default value is the image height minus the value set by the "cropTop" action (or 0 if not set). (Equivalent SignWare SPCleanParameter parameters: SPCutRegionBottom, SPCutRegionTop.)
- cropLeft: set the X coordinate of the upper left corner of the rectangle that will be preserved by the next "crop" action. The default value is 0. See see Coordinate Systems. (Equivalent SignWare SPCleanParameter parameter: SPCutRegionLeft.)
- cropTop: set the Y coordinate of the upper left corner of the rectangle that will be preserved by the next "crop" action. The default value is 0. See see Coordinate Systems. (Equivalent SignWare SPCleanParameter parameter: SPCutRegionTop.)
- cropWidth: Set the width of the rectangle that will be preserved by the next "crop" action. The default value is the image width minus the value set by the "cropLeft" action (or 0 if not set). (Equivalent SignWare SPCleanParameter parameters: SPCutRegionLeft, SPCutRegionRight.)
- rotate: Rotate the image; the value of this action specifies the rotation angle in degreees, positive for counter-clockwise negative for clockwise rotation, see SignDocImage.rotate(). White (or the brightest color in the palette for indexed images) is used as background color. (Equivalent SignWare SPCleanParameter parameters: SPRotateAngle, SPRotateEnable.)
- Parameters
-
[out] | aReturnCode | The return code, ReturnCode.OK iff successful. |
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
- See also
- add(), addBoolean(), addNumber(), getIntegerAt()
void addNumber |
( |
out ReturnCode |
aReturnCode, |
|
|
string |
aName, |
|
|
double |
aValue |
|
) |
| |
Add an action with a floating-point number parameter.
The following action with a floating-point number parameter is available:
- cleanFrames: removes all frames that have a weight smaller than aValue (0.0 through 1.0), see SignDocImage.cleanFrames(). (Equivalent SignWare SPCleanParameter parameters: SPCleanFrameEnable, SPCleanFrameTrust.)
- Parameters
-
[out] | aReturnCode | The return code, ReturnCode.OK iff successful. |
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
- See also
- add(), addBoolean(), addInteger(), getNumberAt()
bool? getBooleanAt |
( |
int |
aIndex | ) |
|
Get the value of a boolean parameter.
This function does not set an error message.
- Parameters
-
[in] | aIndex | The zero-based index of the action. |
- Returns
- The value of the specified parameter or null if aIndex is out of range or if the specified action does not have a boolean parameter.
- See also
- addBoolean()
string getErrorMessage |
( |
| ) |
|
Get an error message for the last function call.
- Returns
- A string describing the reason for the failure of the last function call. The string is empty if the last call succeeded.
int? getIntegerAt |
( |
int |
aIndex | ) |
|
Get the value of an integer parameter.
This function does not set an error message.
- Parameters
-
[in] | aIndex | The zero-based index of the action. |
- Returns
- The value of the specified parameter or null if aIndex is out of range or if the specified action does not have an integer parameter.
- See also
- addInteger()
string getNameAt |
( |
int |
aIndex | ) |
|
Get the name of an action.
- Parameters
-
[in] | aIndex | The zero-based index of the action. |
- Returns
- The name of the action or null if aIndex is out of range.
- See also
- getNumberOfActions(), getTypeAt()
double? getNumberAt |
( |
int |
aIndex | ) |
|
Get the value of a floating-point number parameter.
This function does not set an error message.
- Parameters
-
[in] | aIndex | The zero-based index of the action. |
- Returns
- The value of the specified parameter or null if aIndex is out of range or if the specified action does not have a floating-point number parameter.
- See also
- addNumber()
int getNumberOfActions |
( |
| ) |
|
Get the type of the parameter of an action.
- Parameters
-
[in] | aName | The name of the action (case-sensitive). |
- Returns
- The type of the parameter, see enum CleanParameterType.
The documentation for this class was generated from the following file: