SignatureCapture.RealTimeDataEnabled Property

2/27/2008

Indicates whether signature data can be gathered in real time.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride Property RealTimeDataEnabled As Boolean

public abstract bool RealTimeDataEnabled { get; set; }

public:
virtual property bool RealTimeDataEnabled {
    bool get () abstract;
    void set (bool value) abstract;
}

/** @property */
public abstract boolean get_RealTimeDataEnabled ()

/** @property */
public abstract void set_RealTimeDataEnabled (boolean value)

public abstract function get RealTimeDataEnabled () : boolean

public abstract function set RealTimeDataEnabled (value : boolean)

Remarks

When CapRealTimeData is true and RealTimeDataEnabled is set to true, a series of partial signature data events is raised as the signature is captured until signature capture is terminated.

Else, the captured signature is raised as a single data event when signature capture is terminated.

Setting RealTimeDataEnabled will not cause any change in system behavior until a subsequent BeginCapture is performed. This prevents confusion regarding what would happen if RealTimeDataEnabled were modified between a BeginCapture - EndCapture pairing.

RealTimeDataEnabled is typically initialized to false. It should then be kept current by the service object while the device is enabled.

Accessing RealTimeDataEnabled may cause a PosControlException to be thrown with the following ErrorCode:

Value	Meaning
Illegal	Cannot set to true because CapRealTimeData is false.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

SignatureCapture Class
SignatureCapture Members
Microsoft.PointOfService Namespace