Share via

LineDisplayBase.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 Overrides Property ScreenMode As Integer

public override int ScreenMode { get; set; }

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

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

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

public override function get ScreenMode () : int

public override function set ScreenMode (value : int)

Remarks

LineDisplayBase class verifies that the device has been opened and claimed but not enabled, then retrieves or sets the value of LineDisplayProperties.ScreenMode. If an attempt is made to set ScreenMode while the device is enabled, the LineDisplayBase class throws a PosControlException exception with ErrorCode set to ErrorCode.Illegal. If an attempt is made to change ScreenMode, the LineDisplayProperties class may cause a PosControlException to be thrown with the following ErrorCode:

Value

Meaning

Illegal

The CapScreenMode property is set to false, indicating that screen modes aren’t supported; or

The value specified doesn’t exist in the ScreenModeList property.

Otherwise, when the value of ScreenMode changes, the LineDisplayProperties class does the following:

  • If the values of the GlyphHeight and GlyphWidth properties have changed, the old values are destroyed;

  • The existing windows are destroyed;

  • The device window is recreated; and

  • A ScreenModeChangedEvent event is queued to the service object.

ScreenMode is initialized to 0 (zero) 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.ScreenMode Property
LineDisplay.GlyphHeight Property
LineDisplay.GlyphWidth Property
ScreenModeChangedEvent