VisualElementsRequest VisualElementsRequest VisualElementsRequest VisualElementsRequest Class

Definition

Provides a method to delay the display of the Pin to Start flyout, as well as methods through which you can set the visual elements of the secondary tile to be presented in that flyout as well as alternate versions of the tile that can also be presented as options.

On Windows Phone 8.1, the secondary tile is created without showing the user a flyout, prompting them for confirmation, or allowing them to choose an alternate version of the tile.

public : sealed class VisualElementsRequest : IVisualElementsRequest
public sealed class VisualElementsRequest : IVisualElementsRequest
Public NotInheritable Class VisualElementsRequest Implements IVisualElementsRequest
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This object is obtained by calling the Request method of the VisualElementsRequestedEventArgs object obtained through the VisualElementsRequested event.

Properties

AlternateVisualElements AlternateVisualElements AlternateVisualElements AlternateVisualElements

Gets a set of objects that provide alternate logo images, background and foreground colors, and display name. These alternates are shown to the user in the Pin to Start flyout.

On Windows Phone 8.1, the secondary tile is created without showing the user a flyout, prompting them for confirmation, or allowing them to choose an alternate version of the tile.

public : IVectorView<SecondaryTileVisualElements> AlternateVisualElements { get; }
public IReadOnlyList<SecondaryTileVisualElements> AlternateVisualElements { get; }
Public ReadOnly Property AlternateVisualElements As IReadOnlyList<SecondaryTileVisualElements>
var iReadOnlyList = visualElementsRequest.alternateVisualElements;
Value
IVectorView<SecondaryTileVisualElements> IReadOnlyList<SecondaryTileVisualElements> IReadOnlyList<SecondaryTileVisualElements> IReadOnlyList<SecondaryTileVisualElements>

An array of SecondaryTileVisualElements objects, each of which provides the information for an alternate presentation of the secondary tile.

Remarks

For each SecondaryTileVisualElements object in the array, any property left undeclared is given the default value. App name display properties should be specified for each alternate set because their default is false.

Deadline Deadline Deadline Deadline

Gets the approximate time at which the deferral will time-out.

public : DateTime Deadline { get; }
public DateTimeOffset Deadline { get; }
Public ReadOnly Property Deadline As DateTimeOffset
var dateTimeOffset = visualElementsRequest.deadline;
Value
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The time at which the deferral will time out.

Remarks

If the deferral time-out is reached and the developer has not called the Complete method, the tile properties present before the event was fired are used— all properties set in the handler are ignored.

VisualElements VisualElements VisualElements VisualElements

Gets a copy

of the parent secondary tile's SecondaryTileVisualElements object. The visual elements properties can be set or read through this object. When deferral is complete (or the handler returns without a deferral), the properties in this object are verified and then reflected in the Pin to Start flyout.

public : SecondaryTileVisualElements VisualElements { get; }
public SecondaryTileVisualElements VisualElements { get; }
Public ReadOnly Property VisualElements As SecondaryTileVisualElements
var secondaryTileVisualElements = visualElementsRequest.visualElements;
Value
SecondaryTileVisualElements SecondaryTileVisualElements SecondaryTileVisualElements SecondaryTileVisualElements

The object through which you'll access the visual element properties.

Methods

GetDeferral() GetDeferral() GetDeferral() GetDeferral()

Retrieves a deferral object, which allows the app time to provide information and assets used in the Pin to Start flyout.

public : VisualElementsRequestDeferral GetDeferral()
public VisualElementsRequestDeferral GetDeferral()
Public Function GetDeferral() As VisualElementsRequestDeferral
var visualElementsRequestDeferral = visualElementsRequest.getDeferral();
Returns

Remarks

If you call this method, you must follow it with a call to Complete before the deferral period times out. If you don't, any properties set during the deferral period are ignored.