LineDisplay.InterCharacterWait Property

2/27/2008

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

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

Syntax

'Declaration
Public MustOverride Property InterCharacterWait As Integer

public abstract int InterCharacterWait { get; set; }

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

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

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

public abstract function get InterCharacterWait () : int

public abstract function set InterCharacterWait (value : int)

Remarks

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

Notice that InterCharacterWait is used only if the service object has set the CapICharWait property to true. This indicates that the Line Display device supports intercharacter wait.

If intercharacter 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. Notice 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 the data are not yet 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.

InterCharacterWait is typically initialized to 0 (zero), and it is updated when the application sets the CurrentWindow property or calls the DestroyWindow method.

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

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

LineDisplay Class
LineDisplay Members
Microsoft.PointOfService Namespace