LineDisplayProperties.InterCharacterWait Property

2/27/2008

Holds the wait time, specified in milliseconds, between the display of each character with the DisplayText and DisplayTextAt methods.

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

Syntax

'Declaration
Public Property InterCharacterWait As Integer

public int InterCharacterWait { get; set; }

public:
property int InterCharacterWait {
    int get ();
    void set (int value);
}

/** @property */
public int get_InterCharacterWait ()

/** @property */
public void set_InterCharacterWait (int value)

public function get InterCharacterWait () : int

public function set InterCharacterWait (value : int)

Remarks

InterCharacterWait can be used to give a “teletype” appearance when displaying text.

Note that InterCharacterWait is used only if the service object has set the CapICharWait property to true, indicating that the line display device supports inter-character wait.

If inter-character wait is supported, InterCharacterWait is used only if the window is not in Marquee mode; that is, when the application has set the MarqueeType property to None.

When the InterCharacterWait value is not zero and the window is not in Marquee mode, the window is in Teletype mode: DisplayText and DisplayTextAt requests are queued by the service object and processed in the order they are received. InterCharacterWait specifies the time to wait between outputting each character to the viewport. Note that the system timer resolution can reduce the precision of the wait time.

If the CursorUpdate property is set to true, the CursorRow and CursorColumn properties are updated to their final values by the DisplayText or DisplayTextAt methods before they return, even though all of the data will not yet be displayed.

When the application sets InterCharacterWait to zero and Marquee Type to None, Immediate mode goes into effect and characters are displayed as quickly as possible. If some display requests are queued by the service object when InterCharacterWait is set to zero, the requests are completed as quickly as possible.

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

Value	Meaning
Illegal	One of the following conditions occurred: InterCharacterWait was set, but the CapICharWait property is set to false, indicating the device doesn’t support inter-character wait functionality; or InterCharacterWait was set to a value less than 0 (zero).

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

LineDisplayProperties Class
LineDisplayProperties Members
Microsoft.PointOfService.BaseServiceObjects Namespace
LineDisplayBase.InterCharacterWait Property