Share via

LineDisplay.DeviceBrightness Property (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Gets or sets the device brightness value, expressed as a percentage between 0 and 100.

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

Syntax

'Declaration
Public MustOverride Property DeviceBrightness As Integer

public abstract int DeviceBrightness { get; set; }

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

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

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

public abstract function get DeviceBrightness () : int

public abstract function set DeviceBrightness (value : int)

Remarks

Any device can support 0 percent (blank) and 100 percent (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.

DeviceBrightness is typically initialized to 100.

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

Value

Meaning

Illegal

One of the following conditions has occurred:

  • The CapBrightness property is set to false. This indicates the device does not support the setting of brightness values, but DeviceBrightness was set to a value other than 100.

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

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