LineDisplayBase.BlinkRate Property

2/27/2008

Holds the blink cycle in milliseconds.

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

Syntax

'Declaration
Public Overrides Property BlinkRate As Integer

public override int BlinkRate { get; set; }

public:
virtual property int BlinkRate {
    int get () override;
    void set (int value) override;
}

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

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

public override function get BlinkRate () : int

public override function set BlinkRate (value : int)

Remarks

A blink cycle is the period of time when text completes an on-off-on cycle during blinking. After BlinkRate is set, the service object will set the blink rate to the closest supported rate and change BlinkRate to reflect the actual rate. Performing this approximation is necessary because blink cycles are hardware dependent and probably not controllable at precise millisecond granularity.

BlinkRate is typically initialized to 0 (zero).

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

Value	Meaning
Illegal	BlinkRate has been set to a value less than zero, or BlinkRate has been set to a valid value but the CapBlinkRate property is set to false, indicating that the device doesn’t support blinking.

BlinkRate is initialized to 0 (zero) by the LineDisplayProperties class.

LineDisplayBase class verifies that the device has been opened, then retrieves or sets the value of LineDisplayProperties.BlinkRate.

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

LineDisplayBase Class
LineDisplayBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
LineDisplay.BlinkRate Property
LineDisplay.CapBlinkRate Property
BlinkRateChangedEvent