LineDisplayMarquee LineDisplayMarquee LineDisplayMarquee LineDisplayMarquee Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents an object containing properties describing and allowing control of marquee scrolling on a line display.

public : sealed class LineDisplayMarquee : ILineDisplayMarqueepublic sealed class LineDisplayMarquee : ILineDisplayMarqueePublic NotInheritable Class LineDisplayMarquee Implements ILineDisplayMarquee// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Properties

Format Format Format Format

Prerelease. Gets or sets the current format of the marquee.

public : LineDisplayMarqueeFormat Format { get; set; }public LineDisplayMarqueeFormat Format { get; set; }Public ReadWrite Property Format As LineDisplayMarqueeFormat// You can use this property in JavaScript.

Remarks

When set to None, marquee scrolling is disabled. Changes to this property are committed to the device on the next call to LineDisplayMarquee.TryStartScrollingAsync().

RepeatWaitInterval RepeatWaitInterval RepeatWaitInterval RepeatWaitInterval

Prerelease. Gets or sets the marquee repeat wait period.

public : TimeSpan RepeatWaitInterval { get; set; }public TimeSpan RepeatWaitInterval { get; set; }Public ReadWrite Property RepeatWaitInterval As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The delay between finishing a marquee scroll and starting over again.

Remarks

The default value of this property is 0. Changes to this property are committed to the device on the next call to LineDisplayMarquee.TryStartScrollingAsync().

ScrollWaitInterval ScrollWaitInterval ScrollWaitInterval ScrollWaitInterval

Prerelease. Gets or sets the scroll wait interval.

public : TimeSpan ScrollWaitInterval { get; set; }public TimeSpan ScrollWaitInterval { get; set; }Public ReadWrite Property ScrollWaitInterval As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The delay between placing or walking each character in the marquee.

Remarks

The default value of this property is 0. Changes to this property are committed to the device on the next call to LineDisplayMarquee.TryStartScrollingAsync().

Methods

TryStartScrollingAsync(LineDisplayScrollDirection) TryStartScrollingAsync(LineDisplayScrollDirection) TryStartScrollingAsync(LineDisplayScrollDirection) TryStartScrollingAsync(LineDisplayScrollDirection)

Prerelease. Attempts to asynchronously cause the window which owns this marquee to enter Marquee Mode and start scrolling.

public : IAsyncOperation<PlatForm::Boolean> TryStartScrollingAsync(LineDisplayScrollDirection direction)public IAsyncOperation<bool> TryStartScrollingAsync(LineDisplayScrollDirection direction)Public Function TryStartScrollingAsync(direction As LineDisplayScrollDirection) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
Returns

Returns True if the marquee successfully started scrolling; otherwise, False.

TryStopScrollingAsync() TryStopScrollingAsync() TryStopScrollingAsync() TryStopScrollingAsync()

Prerelease. Attempts to asynchronously exit Marquee mode and/or Marquee Init mode. Format is set to None.

public : IAsyncOperation<PlatForm::Boolean> TryStopScrollingAsync()public IAsyncOperation<bool> TryStopScrollingAsync()Public Function TryStopScrollingAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

Returns True if the marquee was successfully stopped; otherwise, False.

Remarks

If the device is not already claimed when this method is called, this method will claim the device (without delay) and enable the device. If the device is already claimed by another process the call will fail.