Share via

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

  • Article

2/27/2008

Gets or sets the screen mode value of the device.

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

Syntax

'Declaration
Public MustOverride Property ScreenMode As Integer

public abstract int ScreenMode { get; set; }

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

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

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

public abstract function get ScreenMode () : int

public abstract 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 that are contained in the ScreenModeList property. For example:

0 = Default value;

1 = First setting in ScreenModeList;

2 = Second setting in ScreenModeList

Notice 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 because of the columns and rows or because of the columns or rows requiring a different number of physical pixels.

ScreenMode is typically initialized to 0 (zero).

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, that indicates that the device does not support screen mode.

  • 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

LineDisplay Class
LineDisplay Members
Microsoft.PointOfService Namespace
LineDisplay.CapScreenMode Property
LineDisplay.DeviceColumns Property
LineDisplay.DeviceRows Property
LineDisplay.MaximumX Property
LineDisplay.MaximumY Property