Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SecondaryTile.SecondaryTile(String, String, String, String, TileOptions, Uri, Uri) constructor

Applies to Windows and Windows Phone

[This constructor may be altered or unavailable for releases after Windows 8.1. Instead, use SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) and supply other tile sizes and options through SecondaryTile.VisualElements method.]

Creates a SecondaryTile object as a wide tile.

  • Applies to Windows Phone

On Windows Phone 8.1, all tiles—including secondary tiles—are pinned at as medium tiles, after which they can be resized by the user. This constructor provides that option of resizing to a wide tile.

Syntax


var secondaryTile = new Windows.UI.StartScreen.SecondaryTile(tileId, shortName, displayName, arguments, tileOptions, logoReference, wideLogoReference);

Parameters

tileId

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

A string that will uniquely identify the tile within your app's package. Choose a unique ID that is descriptive and meaningful to your app. It is limited to 64 characters and must begin with a number or letter and be composed of the characters a-z, A-Z, 0-9, period (.), or underscore (_). If you provide the same ID as that of an existing secondary tile, the existing secondary tile will be overwritten. Can be set or retrieved through the TileId property.

shortName

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

A short name to display directly on the tile if the app chooses to do so. Anything over 40 characters will be truncated. The user has the option to change this value as part of the pinning process. Can be set or retrieved through the ShortName property.

Note  This value is used only in Windows 8 and is deprecated in favor of the displayName in later versions.

displayName

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

A name to be displayed on the tile, in the tile's tooltip, and when showing small tiles, such as on the Apps or search results screens. This string is equivalent to the display name given in the manifest for the main tile. It is restricted to 256 characters, but in practice should be kept short to avoid truncation. This value can be set or retrieved through the DisplayName property.

  • Applies to Windows Phone

The display name is shown only on the wide secondary tile on Windows Phone 8.1.

arguments

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

An app-defined string meaningful to the calling application. This argument string is passed back to the app when the app is activated from the secondary tile. It will be truncated after 2048 characters. Can be set or retrieved through the Arguments property.

tileOptions

Type: TileOptions

A value that specifies various options such as whether the name will be displayed on the secondary tile. Can be set or retrieved through the TileOptions property.

logoReference

Type: Windows.Foundation.Uri [JavaScript] | System.Uri [.NET] | Windows::Foundation::Uri [C++]

A reference to a medium logo image stored at a URI. Can be set or retrieved through the Square150x150Logo property. This value can be expressed using one of these schemes:

TermDescription

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.

 

wideLogoReference

Type: Windows.Foundation.Uri [JavaScript] | System.Uri [.NET] | Windows::Foundation::Uri [C++]

A reference to a wide logo image stored at a URI. Can be set or retrieved through the WideLogo property. This value can be expressed using one of these schemes:

TermDescription

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.

 

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.UI.StartScreen
Windows::UI::StartScreen [C++]

Metadata

Windows.winmd

See also

SecondaryTile
SecondaryTile()
SecondaryTile(String)
SecondaryTile(String, String, String, String, TileOptions, Uri)
SecondaryTile(String, String, String, Uri, TileSize)
Secondary tiles sample

 

 

Show:
© 2014 Microsoft