Secondary​Tile​Visual​Elements Secondary​Tile​Visual​Elements Secondary​Tile​Visual​Elements Secondary​Tile​Visual​Elements 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.]
Contains properties through which you can get or set a secondary tile's background color, foreground text, tile images, and app name display options. The properties in this class replace these SecondaryTile properties:

public : sealed class SecondaryTileVisualElements : ISecondaryTileVisualElements, ISecondaryTileVisualElements2, ISecondaryTileVisualElements3public sealed class SecondaryTileVisualElements : ISecondaryTileVisualElements, ISecondaryTileVisualElements2, ISecondaryTileVisualElements3Public NotInheritable Class SecondaryTileVisualElements Implements ISecondaryTileVisualElements, ISecondaryTileVisualElements2, ISecondaryTileVisualElements3// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This class object is obtained by calling the SecondaryTile.VisualElements property.

A logo image that is saved locally (ms-appdata://localfolder/) by the app to use in a secondary tile should not be deleted by the app. This prevents loss of the image if the cache is cleared.

Properties

BackgroundColor BackgroundColor BackgroundColor BackgroundColor

Gets or sets the secondary tile's background color.

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

The background color. Specify in #ffffff format.

For Windows Phone Store app, set this value to "transparent" to use the system's accent color, which is chosen by the user in Settings.

Examples

The following lines show different ways to express the color through this property.


secondaryTileVisualElements.backgroundColor = Windows.UI.Colors.magenta;

secondaryTileVisualElements.BackgroundColor = Windows.UI.Color.Magenta;
secondaryTileVisualElements.BackgroundColor = Windows.UI.Color.FromArgb(255, 255, 255, 255);

secondaryTileVisualElements->BackgroundColor = Windows::UI::Colors::Magenta;
secondaryTileVisualElements->BackgroundColor = Windows::UI::ColorHelper::FromArgb(0, 255, 255, 120);

Remarks

If this property is not set, its value is inherited from the background color of the parent app's tile.

See Also

ForegroundText ForegroundText ForegroundText ForegroundText

Specifies whether the tile should use dark or light text.

This value is ignored on Windows Phone 8.1. The foreground text color of a secondary tile on the phone is always light.

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

One of the two values that specifies either the default dark or default light text.

Remarks

If this property is not specified, it is inherited from the foreground text property of the parent app's tile.

Only two text colors are available— default dark and default light— and are set by Windows. Choose the text color that will look best with your choice of background color and the opacity of your logo image.

See Also

ShowNameOnSquare150x150Logo ShowNameOnSquare150x150Logo ShowNameOnSquare150x150Logo ShowNameOnSquare150x150Logo

Specifies whether the display name should be shown on the medium secondary tile.

The display name is never shown on a medium secondary tile on Windows Phone 8.1, so this value is ignored.

public : PlatForm::Boolean ShowNameOnSquare150x150Logo { get; set; }public bool ShowNameOnSquare150x150Logo { get; set; }Public ReadWrite Property ShowNameOnSquare150x150Logo As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True to show the display name on the tile; otherwise, false. The default value is false.

See Also

ShowNameOnSquare310x310Logo ShowNameOnSquare310x310Logo ShowNameOnSquare310x310Logo ShowNameOnSquare310x310Logo

Specifies whether the display name should be shown on the large secondary tile.

The large tile size is not supported on Windows Phone 8.1, so this value is ignored.

public : PlatForm::Boolean ShowNameOnSquare310x310Logo { get; set; }public bool ShowNameOnSquare310x310Logo { get; set; }Public ReadWrite Property ShowNameOnSquare310x310Logo As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True to dhow the display name on the tile; otherwise, false. The default value is false.

See Also

ShowNameOnWide310x150Logo ShowNameOnWide310x150Logo ShowNameOnWide310x150Logo ShowNameOnWide310x150Logo

Specifies whether the display name should be shown on the wide secondary tile.

public : PlatForm::Boolean ShowNameOnWide310x150Logo { get; set; }public bool ShowNameOnWide310x150Logo { get; set; }Public ReadWrite Property ShowNameOnWide310x150Logo As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True to show the display name on the tile; otherwise, false. The default value is false.

See Also

Square150x150Logo Square150x150Logo Square150x150Logo Square150x150Logo

Gets or sets the medium secondary tile image.

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

The location of the image. This can be expressed as one of these schemes: ms-appx:///A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.ms-appdata:///local/A file found in the per-user app storage.

Remarks

This image must be set before you call SecondaryTile.RequestCreateAsync.

See Also

Square30x30Logo Square30x30Logo Square30x30Logo Square30x30Logo

Gets or sets the square30x30 secondary tile image.

The Square30x30 tile size is not supported on Windows Phone 8.1.

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

The location of the image. This can be expressed as one of these schemes: ms-appx:///A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.ms-appdata:///local/A file found in the per-user app storage.

Remarks

If this image is not specified, the parent app's 30 x 30 image is used.

See Also

Square310x310Logo Square310x310Logo Square310x310Logo Square310x310Logo

Gets or sets the large secondary tile image.

The large tile size is not supported on Windows Phone 8.1.

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

The location of the image. This can be expressed as one of these schemes: ms-appx:///A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.ms-appdata:///local/A file found in the per-user app storage.

Remarks

A wide tile image must also be set for the large tile option to be presented to the user.

See Also

Square44x44Logo Square44x44Logo Square44x44Logo Square44x44Logo

Gets or sets the square44x44 secondary tile image.

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

The location of the image. This can be expressed as one of these schemes: ms-appx:///A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.ms-appdata:///local/A file found in the per-user app storage.

Square70x70Logo Square70x70Logo Square70x70Logo Square70x70Logo

Gets or sets the small secondary tile image.

The Square70x70 tile size is not supported on Windows Phone 8.1. Instead, call Square71x71Logo.

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

The location of the image. This can be expressed as one of these schemes: ms-appx:///A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.ms-appdata:///local/A file found in the per-user app storage.

Remarks

If this image is not specified, the Square150x150Logo image is scaled down for use in its place.

See Also

Square71x71Logo Square71x71Logo Square71x71Logo Square71x71Logo

Gets or sets the small secondary tile image.

The Square71x71 tile size is not supported on Windows. Instead, call Square70x70Logo.

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

The location of the image. This can be expressed as one of these schemes: ms-appx:///A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.ms-appdata:///local/A file found in the per-user app storage.

Wide310x150Logo Wide310x150Logo Wide310x150Logo Wide310x150Logo

Gets or sets the wide secondary tile image.

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

The location of the image. This can be expressed as one of these schemes: ms-appx:///A path within the deployed app package. This path is resolved for languages and DPI plateau supported by the app.ms-appdata:///local/A file found in the per-user app storage.

See Also