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

2/27/2008

Gets or sets the marquee format for the active window.

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

Syntax

'Declaration
Public MustOverride Property MarqueeFormat As DisplayMarqueeFormat

public abstract DisplayMarqueeFormat MarqueeFormat { get; set; }

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

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

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

public abstract function get MarqueeFormat () : DisplayMarqueeFormat

public abstract 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 putting characters starting at the left side, and beginning scrolling only after the viewport is full.

The Open and CreateWindow methods initialize the value of MarqueeFormat to Walk, and it is updated when the application sets the CurrentWindow property or calls the DestroyWindow method.

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

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

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 part of the window into the viewport, and then wait MarqueeUnitWait milliseconds. Move the window mapping onto the viewport by one row or column in the marquee direction. Repeat the step until the viewport is full.

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

4. Wait MarqueeRepeatWait milliseconds. Then move 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 steps occur:

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, and then wait MarqueeUnitWait milliseconds. Repeat the step until the viewport is full.

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

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

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 is not found in the DisplayMarqueeFormat enumeration. The active window is Window 0—marquee format 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
MarqueeType
MarqueeUnitWait
MarqueeRepeatWait