Share via

LineDisplayBase.MarqueeType Property

  • Article

2/27/2008

Holds the marquee type for the current window.

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

Syntax

'Declaration
Public Overrides Property MarqueeType As DisplayMarqueeType

public override DisplayMarqueeType MarqueeType { get; set; }

public:
virtual property DisplayMarqueeType MarqueeType {
    DisplayMarqueeType get () override;
    void set (DisplayMarqueeType value) override;
}

/** @property */
public DisplayMarqueeType get_MarqueeType ()

/** @property */
public void set_MarqueeType (DisplayMarqueeType value)

public override function get MarqueeType () : DisplayMarqueeType

public override function set MarqueeType (value : DisplayMarqueeType)

Remarks

Possible values are defined by the DisplayMarqueeType enumeration. When not set to None, the window is in Marquee mode. Valid values are:

Value

Meaning

None

Marquees are disabled for this window.

Init

Marquee Init mode. Changes to the window are not reflected in the viewport until MarqueeType is changed to another value.

Up

Scroll the window up. Illegal unless Rows is greater than the viewportHeight parameter used for the window’s CreateWindow method, and the service object has set the CapVMarquee property to true.

Down

Scroll the window down. Illegal unless Rows is greater than the viewportHeight parameter used for the window’s CreateWindow method, and the service object has set the CapVMarquee property to true.

Left

Scroll the window left. Illegal unless Columns is greater than the viewportWidth parameter used for the window’s CreateWindow method, and the service object has set the CapHMarquee property to true.

Right

Scroll the window right. Illegal unless Columns is greater than the viewportWidth parameter used for the window’s CreateWindow method, and the service object has set the CapHMarquee property to true.

LineDisplayBase class verifies that the device has been opened, then retrieves or sets the value of LineDisplayProperties.MarqueeType, which is the MarqueeType value for the service object’s current window. When MarqueeType is set, the LineDisplayProperties class may cause a PosControlException to be thrown with the following ErrorCode:

Value

Meaning

Illegal

  • If the specified MarqueeType is not a valid DisplayMarqueeType value;

  • If the Current Window is 0 (zero);

  • If the specified MarqueeType is either DisplayMarqueeType.Up or DisplayMarqueeType.Down and the CapVMarquee property is set to false, indicating that vertical marquees aren’t supported;

  • If the specified MarqueeType is either DisplayMarqueeType.Left or DisplayMarqueeType.Right and the CapHMarquee property is set to false, indicating that horizontal marquees aren’t supported;

  • If the specified MarqueeType is either DisplayMarqueeType.Left or DisplayMarqueeType.Right and the current value of the Width property is greater than the current window’s Columns value; or

  • If the specified MarqueeType is either DisplayMarqueeType.Up or DisplayMarqueeType.Down and the current value of the Height property is greater than the current window’s Rows value.

Otherwise, the LineDisplayPropertiesClass sets the service object’s current window’s MarqueeType to the specified value.

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.MarqueeType Property
DisplayMarqueeType Enumeration
LineDisplay.CapHMarquee Property
LineDisplay.CapVMarquee Property