Method SetSignatureRectangle
SetSignatureRectangle(Int32, Int32, Int32, Int32, Object)
Sets the area on the display of the signature device that is to be used for capturing the drawn signature.
Declaration
Error SetSignatureRectangle(int column, int row, int width, int height, object Handle = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | column | The left edge of the rectangle /pixel. |
| System.Int32 | row | The upper edge of the rectangle /pixel. |
| System.Int32 | width | The width of the rectangle /pixel. |
| System.Int32 | height | The height of the rectangle /pixel. |
| System.Object | Handle | Optional window handle for .NET-Framework applications. |
Returns
| Type | Description |
|---|---|
| Error | Error |
Remarks
Passing zeroes sets the signature rectangle to full screen.
Examples
The following example sets a signature rectangle that starts at the upper left corner is 400 pixels wide and 300 pixels high assuming it fits into the display of the device.
C#
r = driver.SetSignatureRectangle(0, 0, 400, 300);
// draw something to see the effect
r = driver.StartSignatureMode(SignMode.StandardSign);SetSignatureRectangle(Int32, Int32, Int32, Int32, Int32, Int32, SignRectOption, SignRectScrollCorrect)
Advanced signature rectangle setter intended for document signing mode.
Declaration
Error SetSignatureRectangle(int column, int row, int width, int height, int scrollColumn, int scrollRow, SignRectOption scrollOption, SignRectScrollCorrect scrollCorrect = SignRectScrollCorrect.None)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | column | The column of the left edge of the rectangle /pixel. |
| System.Int32 | row | The row of the upper edge of the rectangle /pixel. |
| System.Int32 | width | The width of the rectangle /pixel. |
| System.Int32 | height | The height of the rectangle /pixel. |
| System.Int32 | scrollColumn | Scrolls the left edge of the signature rectangle together with the background image to the given column /pixel. |
| System.Int32 | scrollRow | Scrolls the lower edge of the signature rectangle together with the background image to the given row/pixel. |
| SignRectOption | scrollOption | One can switch off the scrolling for both dimensions with this option. |
| SignRectScrollCorrect | scrollCorrect | For DocSign. Corrects the scroll position of the set signature retcangle. |
Returns
| Type | Description |
|---|---|
| Error | Error |
Remarks
If a signature process is started StartSignatureMode(SignMode) with DocumentSign
the three parameters scrollColumn, scrollRow, scrollOption
are used. Otherwise they are ignored.
Centered scrolling takes precedence over the given scrollRow/scrollColumn. If scrollOption CenterXY is passed both, scrollRow and scrollColumn, are ignored.