VisualElementsRequest Class

Reference

Definition

Namespace:: Windows.UI.StartScreen

Important

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

Edit

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 ref class VisualElementsRequest sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class VisualElementsRequest final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class VisualElementsRequest

Public NotInheritable Class VisualElementsRequest

Inheritance: Object Platform::Object IInspectable VisualElementsRequest

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

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

Properties

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.

Deadline

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

VisualElements

Gets a copy of the parent secondary tile's SecondaryTileVisualElementsobject. 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.

Methods

GetDeferral()

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

Applies to

Share via