Edit

uap:VisualElements (Windows 10)

  • Article

Describes the visual aspects of the app: its default tile, logo images, text and background colors, initial screen orientation, splash screen, and lock screen tile appearance.

Element hierarchy

<Package>

    <Applications>

         <Application>

              <uap:VisualElements>

Syntax

<uap:VisualElements
    DisplayName = 'A string with a value between 1 and 256 characters. This string is localizable.' 
    Description = 'A string between 1 and 2048 characters.'
    BackgroundColor = 'A three-byte hexadecimal number preceded by "#" or a named color. See Remarks for a list of named colors.'
    Square150x150Logo = 'A string between 1 and 256 characters in length that ends with ".jpg", ".png", or ".jpeg" that cannot contain these characters: <, >, :, ", |, ?, or *. In this string, the / and \ characters cannot be the first or last characters. Also, the string can contain / or \ but not both.'
    Square44x44Logo = 'A string between 1 and 256 characters in length that ends with ".jpg", ".png", or ".jpeg" that cannot contain these characters: <, >, :, ", |, ?, or *. In this string, the / and \ characters cannot be the first or last characters. Also, the string can contain / or \ but not both.'
    AppListEntry = 'An optional string that can have one of the following values: "default" or "none".' >

  <!-- Child elements -->
  uap:DefaultTile?
  & uap:LockScreen?
  & uap:SplashScreen?
  & uap:InitialRotationPreference?

</uap:VisualElements>

Key

?   optional (zero or one) &   interleave connector (may occur in any order)

Attributes and elements

Attributes

Attribute Description Data type Required Default value
DisplayName A friendly name for the app that can be displayed to users. This string is localizable; see Remarks for details. A string with a value between 1 and 256 characters. This string is localizable. Yes
Description The description of the app. This string is localizable; see Remarks for details. A string between 1 and 2048 characters. Yes
BackgroundColor Specifies the background color of the app tile. See the Remarks section for color names. Yes
Square150x150Logo An image used as the app's Start Screen medium tile, and on the Task Switcher. For more info about how to specify the image in this attribute, see Remarks. A string between 1 and 256 characters in length that ends with .jpg, .png, or .jpeg that cannot contain these characters: <, >, :, ", |, ?, or *. In this string, the / and \ characters cannot be the first or last characters. Also, the string can contain / or \ but not both. Yes
Square44x44Logo An image used as the app's Start Screen small tile, and on the All Apps List. For more info about how to specify the image in this attribute, see Remarks. A string between 1 and 256 characters in length that ends with .jpg, .png, or .jpeg that cannot contain these characters: <, >, :, ", |, ?, or *. In this string, the / and \ characters cannot be the first or last characters. Also, the string can contain / or \ but not both. Yes
AppListEntry The entry in the All Apps List. Select none for entry points that do not need start menu tiles. An optional string that can have one of the following values: "default" or "none". No default

Note

The background color specified here also applies to these items:

  • The button color in any app-owned dialog boxes
  • The App Description page in the Store

Child elements

Child element Description
uap:DefaultTile The default tile that represents the app on the Start screen. This tile is displayed when the app is first installed, before it has received any update notifications. When a tile has no notifications to show, the tile reverts to this default.
uap:InitialRotationPreference Describes the orientations in which the app would prefer to be shown for the best user experience. On a device that can be rotated, such as a tablet, the app will not be redrawn for orientations that are not specified here. For instance, if the app specifies only Landscape and LandscapeFlipped orientations, and the device is rotated to a Portrait orientation, the app will not rotate.
uap:LockScreen Defines the badge and notifications that represent the app on the lock screen, which is shown when the system is locked.
uap:SplashScreen Defines the appearance of the splash screen, which is displayed by the app during launch.

Note

On devices that can't be rotated, an app might be shown in that device's default orientation and the app's preferred orientation will be ignored. However, on a device with a rotation lock activated, your app's preferred rotation will still be honored.

These orientation preference choices apply to both the splash screen and the app UI when a new session is launched for your app. The preferences can be changed during run time through the AutoRotationPreferences property.

Parent elements

Parent element Description
Application Represents an app that comprises part of or all of the functionality delivered in the package.

Remarks

For more info on tile dimension requirements, see Tile sizes.

For the Square150x150Logo and Square44x44Logo images, you can supply images of different scales so that Windows can choose the best size for the device and screen resolution. You can also supply high contrast images for accessibility and localized images to match different UI languages. This feature also allows you to localize the DisplayName and Description attributes. For more info, see the Globalization topic.

Applications/Application/Extensions/Extension/FileTypeAssociation/Logo Applications/Application/Extensions/Extension/Protocol/Logo

Size requirements of two types of logo images are shown here:

Image attribute Scale (Image size in pixels)
Applications/Application/VisualElements/@Square150x150Logo 100 (150x150)
250 (375x375)
Applications/Application/VisualElements/@Square44x44Logo 100 (44x44)
250 (110x110)
Applications/Application/VisualElements/@Tall150x310Logo 100 (150x310)
250 (375x775)

These are the supported background color names:

aliceBlue
antiqueWhite
aqua
aquamarine
azure
beige
bisque
black
blanchedAlmond
blue
blueViolet
brown
burlyWood
cadetBlue
chartreuse
chocolate
coral
cornflowerBlue
cornsilk
crimson
cyan
darkBlue
darkCyan
darkGoldenrod

darkGray
darkGreen
darkKhaki
darkMagenta
darkOliveGreen
darkOrange
darkOrchid
darkRed
darkSalmon
darkSeaGreen
darkSlateBlue
darkSlateGray
darkTurquoise
darkViolet
deepPink
deepSkyBlue
dimGray
dodgerBlue
firebrick
floralWhite
forestGreen
fuchsia
gainsboro
ghostWhite

gold
goldenrod
gray
green
greenYellow
honeydew
hotPink
indianRed
indigo
ivory
khaki
lavender
lavenderBlush
lawnGreen
lemonChiffon
lightBlue
lightCoral
lightCyan
lightGoldenrodYellow
lightGray
lightGreen
lightPink
lightSalmon
lightSeaGreen

lightSkyBlue
lightSlateGray
lightSteelBlue
lightYellow
lime
limeGreen
linen
magenta
maroon
mediumAquamarine
mediumBlue
mediumOrchid
mediumPurple
mediumSeaGreen
mediumSlateBlue
mediumSpringGreen
mediumTurquoise
mediumVioletRed
midnightBlue
mintCream
mistyRose
moccasin
navajoWhite

navy
oldLace
olive
oliveDrab
orange
orangeRed
orchid
paleGoldenrod
paleGreen
paleTurquoise
paleVioletRed
papayaWhip
peachPuff
peru
pink
plum
powderBlue
purple
red
rosyBrown
royalBlue
saddleBrown
salmon

sandyBrown
seaGreen
seaShell
sienna
silver
skyBlue
slateBlue
slateGray
snow
springGreen
steelBlue
tan
teal
thistle
tomato
transparent
turquoise
violet
wheat
white
whiteSmoke
yellow
yellowGreen

Examples

The following example is taken from the package manifest of an SDK sample.

<Applications>
    <Application Id="App" StartPage="default.html">
        <uap:VisualElements 
            DisplayName="ApplicationDataSample"
            Description="Application data sample"
            BackgroundColor="#FFFFFF"               
            Square150x150Logo="images\squareTile-sdk.png" 
            Square44x44Logo="images\smallTile-sdk.png" 
            AppListEntry="default">
            <uap:DefaultTile
                ShowName="allLogos" />
            <uap:LockScreen
                Notification="badge"
                BadgeLogo="images\badgeLogo.png" />
            <uap:SplashScreen
                BackgroundColor="white"
                Image="images\splash-sdk.png" />
            <uap:InitialRotationPreference> 
                <uap:Rotation
                    Preference="portrait" />
            </uap:InitialRotationPreference>            
        </uap:VisualElements>
    </Application>
</Applications>

See also

Requirements

Item Value
Namespace http://schemas.microsoft.com/appx/manifest/uap/windows10
Minimum OS Version Windows 10 version 1511 (Build 10586)