LineDisplayBase.MarqueeFormat Property (POS for .NET v1.12 SDK Documentation)

2/27/2008

Holds the marquee format for the current window.

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

Syntax

'Declaration
Public Overrides Property MarqueeFormat As DisplayMarqueeFormat

public override DisplayMarqueeFormat MarqueeFormat { get; set; }

public:
virtual property DisplayMarqueeFormat MarqueeFormat {
    DisplayMarqueeFormat get () override;
    void set (DisplayMarqueeFormat value) override;
}

/** @property */
public DisplayMarqueeFormat get_MarqueeFormat ()

/** @property */
public void set_MarqueeFormat (DisplayMarqueeFormat value)

public override function get MarqueeFormat () : DisplayMarqueeFormat

public override function set MarqueeFormat (value : DisplayMarqueeFormat)

Remarks

Value	Meaning
Walk	Begin the marquee by 'walking' data from the opposite side. For example, if the marquee type is Left, then the viewport is filled by bringing characters in from the right side and scrolling them to the left.
Place	Begin the marquee by placing data. For example, if the marquee type is Left, then the viewport is filled by placing characters starting at the left side, and beginning scrolling only after the viewport is full.

MarqueeFormat is read when a transition is made to Marquee On mode. It is not used when not in Marquee mode.

When MarqueeFormat is Walk, and a transition is made from Marquee Init mode to Marquee On mode, the following occurs:

1. Map the window to the viewport as follows:

   Marquee Type	Window	Viewport
   Left	First Column	Last Column
   Up	First Row	Last Row
   Right	Last Column	First Column
   Down	Last Row	First Row

   Fill the viewport with blanks. Continue to Step 2 without waiting.

2. Display the mapped portion of the window into the viewport, then wait MarqueeUnitWait milliseconds. Move the window mapping onto the viewport by one row or column in the marquee direction. Repeat until the viewport is full.

3. Refresh the viewport and wait MarqueeUnitWait milliseconds. Move the window mapping by one row or column. Repeat until the last row or column is scrolled into the viewport (in which case, omit the unit wait).

4. Wait MarqueeRepeatWait milliseconds. Then go to step back to Step 1.

When MarqueeFormat is Place, and a transition is made from Marquee Init mode to Marquee On mode, the following occurs:

1. Map the window to the viewport as follows:

   Marquee Type	Window	Viewport
   Left	Column	First Column
   Up	First Row	First Row
   Right	Last Column	Last Column
   Down	Last Row	Last Row

   Fill the viewport with blanks. Continue to Step 2 without waiting.

2. Display a row or column into viewport, then wait MarqueeUnitWait milliseconds. Repeat until the viewport is full.

3. Move the window mapping onto the viewport by one row or column in the marquee direction, and refresh the viewport, then wait MarqueeUnitWait milliseconds. Repeat until the last row or column is scrolled into the viewport (in which case, omit the unit wait).

4. Wait MarqueeRepeatWait milliseconds. Then go to step back to Step 1.

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

Value	Meaning
Illegal	One of the following conditions occurred: The value specified for MarqueeFormat isn’t found in the DisplayMarqueeFormat enumeration, or The current window is Window 0—marquee format can’t be changed for Window 0.

Otherwise, the LineDisplayPropertiesClass sets the service object’s current window’s MarqueeFormat 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.MarqueeFormat Property
DisplayMarqueeFormat Enumeration