Share via

LineDisplayBase.DeviceBrightness Property

  • Article

2/27/2008

Holds the device brightness value, expressed as a percentage between 0 and 100.

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

Syntax

'Declaration
Public Overrides Property DeviceBrightness As Integer

public override int DeviceBrightness { get; set; }

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

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

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

public override function get DeviceBrightness () : int

public override function set DeviceBrightness (value : int)

Remarks

LineDisplayBase class verifies that the device has been opened, claimed, and enabled, then retrieves or sets the value of LineDisplayProperties.DeviceBrightness.

Any device can support 0% (blank) and 100% (full intensity). The service object can also support blanking by sending spaces to the device. If the CapBrightness property is set to true, then the device also supports one or more levels of dimming.

If the line display device does not support the brightness value specified by the application, then the service object will choose an appropriate substitute.

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

Value

Meaning

Illegal

One of the following conditions has occurred:

The CapBrightness property is set to false, indicating the device doesn’t support the setting of brightness values, but DeviceBrightness was set to a value other than 100; or

DeviceBrightness was set to a value less than 0 (zero) or greater than 100.

DeviceBrightness is initialized to 100 by the LineDisplayProperties class.

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.CapBrightness Property
LineDisplay.DeviceBrightness Property