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

  • Article

2/27/2008

Gets or sets the marquee type for the active window.

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

Syntax

'Declaration
Public MustOverride Property MarqueeType As DisplayMarqueeType

public abstract DisplayMarqueeType MarqueeType { get; set; }

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

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

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

public abstract function get MarqueeType () : DisplayMarqueeType

public abstract function set MarqueeType (value : DisplayMarqueeType)

Remarks

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

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 that is used for the window’s CreateWindow method, and the service object has set the CapHMarquee property to true.

A marquee is typically initialized after entering Marquee Init mode by the application setting MarqueeType to Init, then calling the ClearText and DisplayTextAt methods. Then, when MarqueeType is changed to an "on" value, Marquee On mode is entered, and the marquee begins to be displayed in the viewport beginning at the start of the window (or end if the type is right or down).

When the application changes from Marquee On mode to OFF, the marquee stops in place. A later transition back to Marquee On mode continues from the current position.

When the application changes the mode from Marquee On mode to Marquee Init mode, the marquee stops. The application can modify the window, then return to Marquee On mode to restart the marquee with the new data.

Note

MarqueeType is always None for window 0 – the device window.

The Open and CreateWindow methods initialize MarqueeType to None, and it is updated when the application sets the CurrentWindow property or calls the DestroyWindow method.

Accessing MarqueeType may cause a PosControlException to be thrown with the following ErrorCode.

Value

Meaning

Illegal

One of the following conditions occurred:

  • The value specified for MarqueeType is not found in the DisplayMarqueeType enumeration.

  • MarqueeType was set to either Up or Down, but the CapVMarquee property is set to false. This indicates that the device does not support vertical marquees.

  • MarqueeType was set to either DisplayMarqueeType.Right or DisplayMarqueeType.Left. But the CapHMarquee property was set to false. This indicates that the device does not support horizontal marquees.

  • The active window is Window 0—the marquee cannot be changed for Window 0.

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.MarqueeFormat Property
MarqueeUnitWait
LineDisplay.MarqueeRepeatWait Property