Share via

LineDisplayProperties.ScreenMode Property

  • Article

2/27/2008

Holds the screen mode value of the device.

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

Syntax

'Declaration
Public Property ScreenMode As Integer

public int ScreenMode { get; set; }

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

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

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

public function get ScreenMode () : int

public function set ScreenMode (value : int)

Remarks

If the CapScreenMode property is set to false, ScreenMode is always set to 0. If CapScreenMode is set to true, then ScreenMode can be set to index the values contained in the ScreenModeList property. For example:

0 = Default value;

1 = First setting in ScreenModeList;

2 = Second setting in ScreenModeList

Note that ScreenMode can only be updated when the device is opened and claimed, but not enabled.

Changing ScreenMode also changes the DeviceColumns and DeviceRows properties to the new screen size. Also, for some devices, the MaximumX and MaximumY properties may be changed due to the columns and/or rows requiring a different number of physical pixels.

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

Value

Meaning

Illegal

One of the following conditions has occurred:

The device is enabled—screen mode can only be set when the device is opened and claimed, but not enabled;

The CapScreenMode property is set to false, indicating that the device doesn’t support screen mode; or

The index value specified for ScreenMode is either less than 0 (zero) or greater than the length of the ScreenModeList array.

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.ScreenMode Property