Class: SignatureCaptureFormCellProxy¶
SignatureCaptureFormCellProxy is a developer-facing interface that provides access to a SignatureCapture control and allows customizations. In addition it provides access to the IFormCellProxy interface.
Hierarchy¶
-
SignatureCaptureFormCellProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Currently none in this class.
Inherited Accessors¶
Methods¶
Class Methods¶
- getCapturedStatusText
- getInitialStatusText
- getShowTimestampInImage
- getShowUnderline
- getShowXMark
- getTimestampFormatter
- getWatermarkText
- getWatermarkTextMaxLines
- setCapturedStatusText
- setInitialStatusText
- setShowTimestampInImage
- setShowUnderline
- setShowXMark
- setTimestampFormatter
- setWatermarkText
- setWatermarkTextMaxLines
Inherited Methods¶
Constructors¶
constructor¶
+ new SignatureCaptureFormCellProxy(context: IContext): SignatureCaptureFormCellProxy
Inherited from FormCellControlProxy.constructor
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
context |
IContext |
Returns: SignatureCaptureFormCellProxy
Methods¶
getCapturedStatusText¶
▸ getCapturedStatusText(): string
Returns the CapturedStatusText property value defined for the FormCell's control.
Returns: string
getInitialStatusText¶
▸ getInitialStatusText(): string
Returns the InitialStatusText property value defined for the FormCell's control.
Returns: string
getShowTimestampInImage¶
▸ getShowTimestampInImage(): boolean
Implementation of ISignatureCaptureFormCellProxy
Returns the ShowTimestampInImage property value defined for the FormCell's control.
Returns: boolean
getShowUnderline¶
▸ getShowUnderline(): boolean
Implementation of ISignatureCaptureFormCellProxy
Returns the ShowUnderline property value defined for the FormCell's control.
Returns: boolean
getShowXMark¶
▸ getShowXMark(): boolean
Implementation of ISignatureCaptureFormCellProxy
Returns the ShowXMark property value defined for the FormCell's control.
Returns: boolean
getTimestampFormatter¶
▸ getTimestampFormatter(): string
Implementation of ISignatureCaptureFormCellProxy
Returns the TimestampFormatter property value defined for the FormCell's control.
Returns: string
getWatermarkText¶
▸ getWatermarkText(): string
Implementation of ISignatureCaptureFormCellProxy
Returns the WatermarkText property value defined for the FormCell's control.
Returns: string
getWatermarkTextMaxLines¶
▸ getWatermarkTextMaxLines(): number
Implementation of ISignatureCaptureFormCellProxy
Returns the WatermarkTextMaxLines property value defined for the FormCell's control.
Returns: number
setCapturedStatusText¶
▸ setCapturedStatusText(capturedStatusText: string): void
Sets the CapturedStatusText property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
capturedStatusText |
string | value to set. |
Returns: void
setInitialStatusText¶
▸ setInitialStatusText(initialStatusText: string): void
Sets the InitialStatusText property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
initialStatusText |
string | value to set. |
Returns: void
setShowTimestampInImage¶
▸ setShowTimestampInImage(showTimestampInImage: boolean): void
Implementation of ISignatureCaptureFormCellProxy
Sets the ShowTimestampInImage property of the FormCell's FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
showTimestampInImage |
boolean | value to set. |
Returns: void
setShowUnderline¶
▸ setShowUnderline(showUnderline: boolean): void
Implementation of ISignatureCaptureFormCellProxy
Sets the ShowUnderline property of the FormCell's FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
showUnderline |
boolean | value to set. |
Returns: void
setShowXMark¶
▸ setShowXMark(showXMark: boolean): void
Implementation of ISignatureCaptureFormCellProxy
Sets the ShowXMark property of the FormCell's FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
showXMark |
boolean | value to set. |
Returns: void
setTimestampFormatter¶
▸ setTimestampFormatter(timestampFormatter: string): void
Implementation of ISignatureCaptureFormCellProxy
Sets the TimestampFormatter property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
timestampFormatter |
string | value to set. |
Returns: void
setWatermarkText¶
▸ setWatermarkText(watermarkText: string): void
Implementation of ISignatureCaptureFormCellProxy
Sets the WatermarkText property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
watermarkText |
string | value to set. |
Returns: void
setWatermarkTextMaxLines¶
▸ setWatermarkTextMaxLines(watermarkTextMaxLines: number): void
Implementation of ISignatureCaptureFormCellProxy
Sets the WatermarkTextMaxLines property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
watermarkTextMaxLines |
number | value to set. |
Returns: void