mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-12 13:27:23 +00:00
updates
This commit is contained in:
parent
12b4858228
commit
e10050345e
@ -1,284 +0,0 @@
|
|||||||
---
|
|
||||||
title: Start layout XML
|
|
||||||
description: This article describes the options for customizing Start layout in LayoutModification.xml for Windows 10 desktop editions.
|
|
||||||
ms.topic: reference
|
|
||||||
ms.date: 10/02/2018
|
|
||||||
appliesto:
|
|
||||||
- ✅ <a href=/windows/release-health/supported-versions-windows-client target=_blank>Windows 10</a>
|
|
||||||
---
|
|
||||||
|
|
||||||
# Start layout XML
|
|
||||||
|
|
||||||
The groups have the following constraints:
|
|
||||||
|
|
||||||
- Two groups that are six columns wide, or equivalent to the width of three medium tiles
|
|
||||||
- Two medium-sized tile rows in height. Windows 10 ignores any tiles that are pinned beyond the second row.
|
|
||||||
- No limit to the number of apps that can be pinned. There's a theoretical limit of 24 tiles per group (four small tiles per medium square x 3 columns x 2 rows).
|
|
||||||
|
|
||||||
## LayoutModification XML
|
|
||||||
|
|
||||||
### Supported elements and attributes
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> RequiredStartGroupsCollection and AppendGroup syntax only apply when the Import-StartLayout method is used for building and deploying Windows images.
|
|
||||||
|
|
||||||
| Element | Attributes | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| LayoutModificationTemplate | xmlns</br>xmlns:defaultlayout</br>xmlns:start</br>Version | Use to describe the changes to the default Start layout |
|
|
||||||
| [LayoutOptions](#layoutoptions)</br></br>Parent:</br>LayoutModificationTemplate | StartTileGroupsColumnCount</br>FullScreenStart | Use to specify:</br>- Whether to use full screen Start on the desktop</br>- The number of tile columns in the Start menu |
|
|
||||||
| RequiredStartGroupsCollection</br></br>Parent:</br>LayoutModificationTemplate | n/a | Use to contain collection of RequiredStartGroups |
|
|
||||||
| [RequiredStartGroups](#requiredstartgroups)</br></br>Parent:</br>RequiredStartGroupsCollection | Region | Use to contain the AppendGroup tags, which represent groups that can be appended to the default Start layout |
|
|
||||||
| [AppendGroup](#appendgroup)</br></br>Parent:</br>RequiredStartGroups | Name | Use to specify the tiles that need to be appended to the default Start layout |
|
|
||||||
| [start:Tile](#specify-start-tiles)</br></br>Parent:</br>AppendGroup | AppUserModelID</br>Size</br>Row</br>Column | Use to specify any of the following:</br>- A Universal Windows app</br>- A Windows 8 or Windows 8.1 app</br></br>Note that AppUserModelID is case-sensitive. |
|
|
||||||
| start:Folder<br><br>Parent:<br>start:Group | Name (in Windows 10, version 1809 and later only)<br>Size<br>Row<br>Column<br>LocalizedNameResourcetag | Use to specify a folder of icons; can include [Tile](#start-tile), [SecondaryTile](#start-secondarytile), and [DesktopApplicationTile](#start-desktopapplicationtile). |
|
|
||||||
| start:DesktopApplicationTile</br></br>Parent:</br>AppendGroup | DesktopApplicationID</br>DesktopApplicationLinkPath</br>Size</br>Row</br>Column | Use to specify any of the following:</br>- A Windows desktop application with a known AppUserModelID</br>- An application in a known folder with a link in a legacy Start Menu folder</br>- A Windows desktop application link in a legacy Start Menu folder</br>- A Web link tile with an associated `.url` file that is in a legacy Start Menu folder |
|
|
||||||
| start:SecondaryTile</br></br>Parent:</br>AppendGroup | AppUserModelID</br>TileID</br>Arguments</br>DisplayName</br>Square150x150LogoUri</br>ShowNameOnSquare150x150Logo</br>ShowNameOnWide310x150Logo</br>Wide310x150LogoUri</br>BackgroundColor</br>ForegroundText</br>IsSuggestedApp</br>Size</br>Row</br>Column | Use to pin a Web link through a Microsoft Edge secondary tile. Note that AppUserModelID is case-sensitive. |
|
|
||||||
| TopMFUApps</br></br>Parent:</br>LayoutModificationTemplate | n/a | Use to add up to three default apps to the frequently used apps section in the system area.</br></br>**Note**: Only applies to versions of Windows 10 earlier than version 1701. In Windows 10, version 1709, you can no longer pin apps to the Most Frequently Used apps list in Start. |
|
|
||||||
| Tile</br></br>Parent:</br>TopMFUApps | AppUserModelID | Use with the TopMFUApps tags to specify an app with a known AppUserModelID. </br></br>**Note**: Only applies to versions of Windows 10 earlier than version 1701. In Windows 10, version 1709, you can no longer pin apps to the Most Frequently Used apps list in Start. |
|
|
||||||
| DesktopApplicationTile</br></br>Parent:</br>TopMFUApps | LinkFilePath | Use with the TopMFUApps tags to specify an app without a known AppUserModelID.</br></br>**Note**: Only applies to versions of Windows 10 earlier than version 1701. In Windows 10, version 1709, you can no longer pin apps to the Most Frequently Used apps list in Start. |
|
|
||||||
| AppendOfficeSuite</br></br>Parent:</br>LayoutModificationTemplate | n/a | Use to add the in-box installed Office suite to Start. For more information, see [Customize the Office suite of tiles](/windows-hardware/customize/desktop/customize-start-layout#customize-the-office-suite-of-tiles).</br></br>Don't use this tag with AppendDownloadOfficeTile. |
|
|
||||||
| AppendDownloadOfficeTile</br></br>Parent:</br>LayoutModificationTemplate | n/a | Use to add a specific **Download Office** tile to a specific location in Start</br></br>Do not use this tag with AppendOfficeSuite |
|
|
||||||
|
|
||||||
### LayoutOptions
|
|
||||||
|
|
||||||
New devices running Windows 10 for desktop editions will default to a Start menu with two columns of tiles unless boot to tablet mode is enabled. Devices with screens that are under 10" have boot to tablet mode enabled by default. For these devices, users see the full screen Start on the desktop. You can adjust the following features:
|
|
||||||
|
|
||||||
- Boot to tablet mode can be set on or off
|
|
||||||
- Set full screen Start on desktop to on or off
|
|
||||||
To do this, add the LayoutOptions element in your LayoutModification.xml file and set the FullScreenStart attribute to true or false
|
|
||||||
- Specify the number of columns in the Start menu to 1 or 2
|
|
||||||
To do this, add the LayoutOptions element in your LayoutModification.xml file and set the StartTileGroupsColumnCount attribute to 1 or 2
|
|
||||||
|
|
||||||
The following example shows how to use the LayoutOptions element to specify full screen Start on the desktop and to use one column in the Start menu:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<LayoutModificationTemplate
|
|
||||||
xmlns="http://schemas.microsoft.com/Start/2014/LayoutModification"
|
|
||||||
xmlns:defaultlayout="http://schemas.microsoft.com/Start/2014/FullDefaultLayout"
|
|
||||||
xmlns:start="http://schemas.microsoft.com/Start/2014/StartLayout"
|
|
||||||
Version="1">
|
|
||||||
<LayoutOptions
|
|
||||||
StartTileGroupsColumnCount="1"
|
|
||||||
FullScreenStart="true"
|
|
||||||
/>
|
|
||||||
</LayoutModificationTemplate>
|
|
||||||
```
|
|
||||||
|
|
||||||
### RequiredStartGroups
|
|
||||||
|
|
||||||
The **RequiredStartGroups** tag contains **AppendGroup** tags that represent groups that you can append to the default Start layout.
|
|
||||||
|
|
||||||
>[!IMPORTANT]
|
|
||||||
>You can add a maximum of two **AppendGroup** tags per **RequiredStartGroups** tag.
|
|
||||||
|
|
||||||
You can also assign regions to the append groups in the **RequiredStartGroups** tag's using the optional **Region** attribute or you can use the multivariant capabilities in Windows provisioning. If you're using the **Region** attribute, you must use a two-letter country code to specify the country/region that the append group(s) apply to. To specify more than one country/region, use a pipe ("|") delimiter as shown in the following example:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<RequiredStartGroups
|
|
||||||
Region="DE|ES|FR|GB|IT|US">
|
|
||||||
```
|
|
||||||
|
|
||||||
If the country/region setting for the Windows device matches a **RequiredStartGroups**, then the tiles laid out within the **RequiredStartGroups** is applied to Start.
|
|
||||||
|
|
||||||
If you specify a region-agnostic **RequiredStartGroups** (or one without the optional Region attribute), then the region-agnostic **RequiredStartGroups** is applied to Start.
|
|
||||||
|
|
||||||
### AppendGroup
|
|
||||||
|
|
||||||
**AppendGroup** tags specify a group of tiles that will be appended to Start. There is a maximum of two **AppendGroup** tags allowed per **RequiredStartGroups** tag.
|
|
||||||
|
|
||||||
For Windows 10 for desktop editions, AppendGroup tags contain start:Tile, start:DesktopApplicationTile, or start:SecondaryTile tags.
|
|
||||||
|
|
||||||
You can specify any number of tiles in an **AppendGroup**, but you can't specify a tile with a **Row** attribute greater than 1. The Start layout doesn't support overlapping tiles.
|
|
||||||
|
|
||||||
### Specify Start tiles
|
|
||||||
|
|
||||||
To pin tiles to Start, partners must use the right tile depending on what you want to pin.
|
|
||||||
|
|
||||||
#### Tile size and coordinates
|
|
||||||
|
|
||||||
All tile types require a size (**Size**) and coordinates (**Row** and **Column**) attributes regardless of the tile type that you use when prepinning items to Start.
|
|
||||||
|
|
||||||
The following table describes the attributes that you must use to specify the size and location for the tile.
|
|
||||||
|
|
||||||
| Attribute | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| Size | Determines how large the tile will be.</br></br>- 1x1 - small tile</br>- 2x2 - medium tile</br>- 4x2 - wide tile</br>- 4x4 - large tile |
|
|
||||||
| Row | Specifies the row where the tile will appear. |
|
|
||||||
| Column | Specifies the column where the tile will appear. |
|
|
||||||
|
|
||||||
For example, a tile with Size="2x2", Row="2", and Column="2" results in a tile located at (2,2) where (0,0) is the top-left corner of a group.
|
|
||||||
|
|
||||||
#### start:Tile
|
|
||||||
|
|
||||||
You can use the **start:Tile** tag to pin any of the following apps to Start:
|
|
||||||
|
|
||||||
- A Universal Windows app
|
|
||||||
- A Windows 8 app or Windows 8.1 app
|
|
||||||
|
|
||||||
To specify any one of these apps, you must set the **AppUserModelID** attribute to the application user model ID that's associated with the corresponding app.
|
|
||||||
|
|
||||||
>[!IMPORTANT]
|
|
||||||
>**AppUserModelID** (AUMID) is case-sensitive.
|
|
||||||
|
|
||||||
The following example shows how to pin the Microsoft Edge Universal Windows app:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<start:Tile
|
|
||||||
AppUserModelID="Microsoft.MicrosoftEdge_8wekyb3d8bbwe!MicrosoftEdge"
|
|
||||||
Size="2x2"
|
|
||||||
Row="0"
|
|
||||||
Column="0"/>
|
|
||||||
```
|
|
||||||
|
|
||||||
<span id="start-desktopapplicationtile" />
|
|
||||||
#### start:DesktopApplicationTile
|
|
||||||
|
|
||||||
You can use the **start:DesktopApplicationTile** tag to pin a Windows desktop application to Start. There are two ways you can specify a Windows desktop application:
|
|
||||||
|
|
||||||
- Use a path to a shortcut link (.lnk file) to a Windows desktop application.
|
|
||||||
|
|
||||||
>[!NOTE]
|
|
||||||
>In Start layouts for Windows 10, version 1703, you should use **DesktopApplicationID** rather than **DesktopApplicationLinkPath** if you are using Group Policy or MDM to apply the start layout and the application was installed after the user's first sign-in.
|
|
||||||
|
|
||||||
To pin a Windows desktop application through this method, you must first add the .lnk file in the specified location when the device first boots.
|
|
||||||
|
|
||||||
The following example shows how to pin the Command Prompt:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<start:DesktopApplicationTile
|
|
||||||
DesktopApplicationLinkPath="%appdata%\Microsoft\Windows\Start Menu\Programs\System Tools\Command Prompt.lnk"
|
|
||||||
Size="2x2"
|
|
||||||
Row="0"
|
|
||||||
Column="4"/>
|
|
||||||
```
|
|
||||||
|
|
||||||
You must set the **DesktopApplicationLinkPath** attribute to the .lnk file that points to the Windows desktop application. The path also supports environment variables.
|
|
||||||
|
|
||||||
If you are pointing to a third-party Windows desktop application and the layout is being applied before the first boot, you must put the .lnk file in a legacy Start Menu directory before first boot; for example, "%APPDATA%\Microsoft\Windows\Start Menu\Programs\" or the all users profile "%ALLUSERSPROFILE%\Microsoft\Windows\Start Menu\Programs\".
|
|
||||||
|
|
||||||
- Use the application's application user model ID, if this is known. If the Windows desktop application doesn't have one, use the shortcut link option.
|
|
||||||
|
|
||||||
You can use the [Get-StartApps cmdlet](/powershell/module/startlayout/get-startapps) on a PC that has the application pinned to Start to obtain the app ID.
|
|
||||||
|
|
||||||
To pin a Windows desktop application through this method, you must set the **DesktopApplicationID** attribute to the application user model ID that's associated with the corresponding app.
|
|
||||||
|
|
||||||
The following example shows how to pin the File Explorer Windows desktop application:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<start:DesktopApplicationTile
|
|
||||||
DesktopApplicationID="Microsoft.Windows.Explorer"
|
|
||||||
Size="2x2"
|
|
||||||
Row="0"
|
|
||||||
Column="2"/>
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also use the **start:DesktopApplicationTile** tag as one of the methods for pinning a Web link to Start. The other method is to use a Microsoft Edge secondary tile.
|
|
||||||
|
|
||||||
To pin a legacy `.url` shortcut to Start, you must create a `.url` file (right-click on the desktop, select **New** > **Shortcut**, and then type a Web URL). You must add this `.url` file in a legacy Start Menu directory before first boot; for example, `%APPDATA%\Microsoft\Windows\Start Menu\Programs\` or the all users profile `%ALLUSERSPROFILE%\Microsoft\Windows\Start Menu\Programs\`.
|
|
||||||
|
|
||||||
The following example shows how to create a tile of the Web site's URL, which you can treat similarly to a Windows desktop application tile:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<start:DesktopApplicationTile
|
|
||||||
DesktopApplicationID="http://www.contoso.com/"
|
|
||||||
Size="2x2"
|
|
||||||
Row="0"
|
|
||||||
Column="2"/>
|
|
||||||
```
|
|
||||||
|
|
||||||
>[!NOTE]
|
|
||||||
>In Windows 10, version 1703, `Export-StartLayout` will use **DesktopApplicationLinkPath** for the .url shortcut. You must change **DesktopApplicationLinkPath** to **DesktopApplicationID** and provide the URL.
|
|
||||||
|
|
||||||
<span id="start-secondarytile" />
|
|
||||||
#### start:SecondaryTile
|
|
||||||
|
|
||||||
You can use the **start:SecondaryTile** tag to pin a Web link through a Microsoft Edge secondary tile. This method doesn't require any additional action compared to the method of using legacy `.url` shortcuts (through the start:DesktopApplicationTile tag).
|
|
||||||
|
|
||||||
The following example shows how to create a tile of the Web site's URL using the Microsoft Edge secondary tile:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<start:SecondaryTile
|
|
||||||
AppUserModelID="Microsoft.MicrosoftEdge_8wekyb3d8bbwe!MicrosoftEdge"
|
|
||||||
TileID="MyWeblinkTile"
|
|
||||||
Arguments="http://msn.com"
|
|
||||||
DisplayName="MySite"
|
|
||||||
Square150x150LogoUri="ms-appx:///Assets/MicrosoftEdgeSquare150x150.png"
|
|
||||||
|
|
||||||
Wide310x150LogoUri="ms-appx:///Assets/MicrosoftEdgeWide310x150.png"
|
|
||||||
ShowNameOnSquare150x150Logo="true"
|
|
||||||
ShowNameOnWide310x150Logo="false"
|
|
||||||
BackgroundColor="#FF112233"
|
|
||||||
Size="2x2"
|
|
||||||
Row="0"
|
|
||||||
Column="4"/>
|
|
||||||
```
|
|
||||||
|
|
||||||
The following table describes the other attributes that you can use with the **start:SecondaryTile** tag in addition to **Size**, **Row**, and **Column**.
|
|
||||||
|
|
||||||
| Attribute | Required/optional | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| AppUserModelID | Required | Must point to Microsoft Edge. Note that AppUserModelID is case-sensitive. |
|
|
||||||
| TileID | Required | Must uniquely identify your Web site tile. |
|
|
||||||
| Arguments | Required | Must contain the URL of your Web site. |
|
|
||||||
| DisplayName | Required | Must specify the text that you want users to see. |
|
|
||||||
| Square150x150LogoUri | Required | Specifies the logo to use on the 2x2 tile. |
|
|
||||||
| Wide310x150LogoUri | Optional | Specifies the logo to use on the 4x2 tile. |
|
|
||||||
| ShowNameOnSquare150x150Logo | Optional | Specifies whether the display name is shown on the 2x2 tile. The values you can use for this attribute are true or false. |
|
|
||||||
| ShowNameOnWide310x150Logo | Optional | Specifies whether the display name is shown on the 4x2 tile. The values you can use for this attribute are true or false. |
|
|
||||||
| BackgroundColor | Optional | Specifies the color of the tile. You can specify the value in ARGB hexadecimal (for example, #FF112233) or specify "transparent". |
|
|
||||||
| ForegroundText | Optional | Specifies the color of the foreground text. Set the value to either "light" or "dark". |
|
|
||||||
|
|
||||||
Secondary Microsoft Edge tiles have the same size and location behavior as a Universal Windows app, Windows 8 app, or Windows 8.1 app.
|
|
||||||
|
|
||||||
#### AppendOfficeSuite
|
|
||||||
|
|
||||||
You can use the `AppendOfficeSuite` tag to add the in-box installed Office suite of apps to Start.
|
|
||||||
|
|
||||||
>[!NOTE]
|
|
||||||
>The OEM must have installed Office for this tag to work.
|
|
||||||
|
|
||||||
The following example shows how to add the `AppendOfficeSuite` tag to your `LayoutModification.xml` file to append the full Universal Office suite to Start:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<LayoutModificationTemplate
|
|
||||||
xmlns="http://schemas.microsoft.com/Start/2014/LayoutModification"
|
|
||||||
xmlns:defaultlayout="http://schemas.microsoft.com/Start/2014/FullDefaultLayout"
|
|
||||||
xmlns:start="http://schemas.microsoft.com/Start/2014/StartLayout"
|
|
||||||
Version="1">
|
|
||||||
<AppendOfficeSuite/>
|
|
||||||
</LayoutModificationTemplate>
|
|
||||||
```
|
|
||||||
|
|
||||||
#### AppendOfficeSuiteChoice
|
|
||||||
|
|
||||||
This tag is added in Windows 10, version 1801. You have two options in this tag:
|
|
||||||
|
|
||||||
- `<AppendOfficeSuiteChoice Choice="DesktopBridgeSubscription"/>`
|
|
||||||
- `<AppendOfficeSuiteChoice Choice="DesktopBridge"/>`
|
|
||||||
|
|
||||||
Use `Choice=DesktopBridgeSubscription` on devices running Windows 10, version 1803, that have Office 365 preinstalled. This will set the heading of the Office suite of tiles to **Office 365**, to highlight the Office 365 apps that you've made available on the device.
|
|
||||||
|
|
||||||
Use `Choice=DesktopBridge` on devices running versions of Windows 10 earlier than version 1803, and on devices shipping with [perpetual licenses for Office](/archive/blogs/ausoemteam/choosing-the-right-office-version-for-your-customers). This will set the heading of the Office suite of tiles to **Create**.
|
|
||||||
|
|
||||||
For more information, see [Customize the Office suite of tiles](/windows-hardware/customize/desktop/customize-start-layout#customize-the-office-suite-of-tiles).
|
|
||||||
|
|
||||||
#### AppendDownloadOfficeTile
|
|
||||||
|
|
||||||
You can use the **AppendDownloadOfficeTile** tag to append the Office trial installer to Start. This tag adds the **Download Office** tile to Start and the download tile will appear at the bottom right-hand side of the second group.
|
|
||||||
|
|
||||||
>[!NOTE]
|
|
||||||
>The OEM must have installed the Office trial installer for this tag to work.
|
|
||||||
|
|
||||||
The following example shows how to add the **AppendDownloadOfficeTile** tag to your LayoutModification.xml file:
|
|
||||||
|
|
||||||
```XML
|
|
||||||
<LayoutModificationTemplate
|
|
||||||
xmlns="http://schemas.microsoft.com/Start/2014/LayoutModification"
|
|
||||||
xmlns:defaultlayout="http://schemas.microsoft.com/Start/2014/FullDefaultLayout"
|
|
||||||
xmlns:start="http://schemas.microsoft.com/Start/2014/StartLayout"
|
|
||||||
Version="1">
|
|
||||||
<AppendDownloadOfficeTile/>
|
|
||||||
</LayoutModificationTemplate>
|
|
||||||
```
|
|
@ -122,20 +122,23 @@ Here you can find an example of Start layout that you can use as a reference:
|
|||||||
> [!CAUTION]
|
> [!CAUTION]
|
||||||
> When you make changes to the exported layout, be aware that the XML file must adhere to an [XML schema definition (XSD)](xsd.md).
|
> When you make changes to the exported layout, be aware that the XML file must adhere to an [XML schema definition (XSD)](xsd.md).
|
||||||
>
|
>
|
||||||
> The XML file requires the following order for tags directly under the LayoutModificationTemplate node:
|
> The XML file requires the following order for tags directly under the `LayoutModificationTemplate` node:
|
||||||
>
|
>
|
||||||
> 1. LayoutOptions
|
> 1. `LayoutOptions`
|
||||||
> 1. DefaultLayoutOverride
|
> 1. `DefaultLayoutOverride`
|
||||||
> 1. RequiredStartGroupsCollection
|
> 1. `RequiredStartGroupsCollection`
|
||||||
> 1. AppendDownloadOfficeTile - OR - AppendOfficeSuite (only one Office option can be used at a time)
|
> 1. `AppendDownloadOfficeTile` - OR - `AppendOfficeSuite` (only one Office option can be used at a time)
|
||||||
> 1. AppendOfficeSuiteChoice
|
> 1. `AppendOfficeSuiteChoice`
|
||||||
> 1. TopMFUApps
|
> 1. `TopMFUApps`
|
||||||
> 1. CustomTaskbarLayoutCollection
|
> 1. `CustomTaskbarLayoutCollection`
|
||||||
> 1. InkWorkspaceTopApps
|
> 1. `InkWorkspaceTopApps`
|
||||||
> 1. StartLayoutCollection
|
> 1. `StartLayoutCollection`
|
||||||
>
|
>
|
||||||
> Comments are not supported in the `LayoutModification.xml` file.
|
> Comments are not supported in the `LayoutModification.xml` file.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> `RequiredStartGroupsCollection` and `AppendGroup` syntax only apply when the `Import-StartLayout` method is used for building and deploying Windows images.
|
||||||
|
|
||||||
You can edit the XML file to make any modifications to the Start layout. For example, you can include `<CustomTaskbarLayoutCollection>` to include the Taskbar customization.
|
You can edit the XML file to make any modifications to the Start layout. For example, you can include `<CustomTaskbarLayoutCollection>` to include the Taskbar customization.
|
||||||
|
|
||||||
If the Start layout that you export contains tiles for desktop apps or URL links, `Export-StartLayout` uses `DesktopApplicationLinkPath` in the resulting file. Use a text or XML editor to change `DesktopApplicationLinkPath` to `DesktopApplicationID`.
|
If the Start layout that you export contains tiles for desktop apps or URL links, `Export-StartLayout` uses `DesktopApplicationLinkPath` in the resulting file. Use a text or XML editor to change `DesktopApplicationLinkPath` to `DesktopApplicationID`.
|
||||||
@ -154,6 +157,249 @@ After you export the layout, decide whether you want to apply a *full* Start lay
|
|||||||
- When a full Start layout is applied, the users can't pin, unpin, or uninstall apps from Start. Users can view and open all apps in the **All Apps** view, but they can't pin any apps to Start
|
- When a full Start layout is applied, the users can't pin, unpin, or uninstall apps from Start. Users can view and open all apps in the **All Apps** view, but they can't pin any apps to Start
|
||||||
- When a partial Start layout is applied, the contents of the specified tile groups can't be changed, but users can move those groups, and can also create and customize their own groups
|
- When a partial Start layout is applied, the contents of the specified tile groups can't be changed, but users can move those groups, and can also create and customize their own groups
|
||||||
|
|
||||||
|
### Supported elements and attributes
|
||||||
|
|
||||||
|
| Element | Description |
|
||||||
|
|--|--|
|
||||||
|
| `LayoutModificationTemplate` | Use to describe the changes to the default Start layout |
|
||||||
|
| [LayoutOptions](#layoutoptions)</br></br>Parent:</br>`LayoutModificationTemplate` | Use to specify:</br>- Whether to use full screen Start on the desktop</br>- The number of tile columns in the Start menu |
|
||||||
|
| `RequiredStartGroupsCollection`</br></br>Parent:</br>`LayoutModificationTemplate` | Use to contain collection of `RequiredStartGroups` |
|
||||||
|
| [RequiredStartGroups](#requiredstartgroups)</br></br>Parent:</br>`RequiredStartGroupsCollection` | Use to contain the `AppendGroup` tags, which represent groups that can be appended to the default Start layout |
|
||||||
|
| [AppendGroup](#appendgroup)</br></br>Parent:</br>`RequiredStartGroups` | Use to specify the tiles that need to be appended to the default Start layout |
|
||||||
|
| [start:Tile](#specify-start-tiles)</br></br>Parent:</br>AppendGroup | Use to specify any of the following:</br>- A Universal Windows app</br>- A Windows 8 or Windows 8.1 app</br></br>Note that AppUserModelID is case-sensitive. |
|
||||||
|
| `start:Folder`<br><br>Parent:<br>start:Group | Use to specify a folder of icons; can include [Tile](#start-tile), [SecondaryTile](#start-secondarytile), and [DesktopApplicationTile](#start-desktopapplicationtile). |
|
||||||
|
| `start:DesktopApplicationTile`</br></br>Parent:</br>AppendGroup | Use to specify any of the following:</br>- A Windows desktop application with a known AppUserModelID</br>- An application in a known folder with a link in a legacy Start Menu folder</br>- A Windows desktop application link in a legacy Start Menu folder</br>- A Web link tile with an associated `.url` file that is in a legacy Start Menu folder |
|
||||||
|
|` start:SecondaryTile`</br></br>Parent:</br>AppendGroup | Use to pin a Web link through a Microsoft Edge secondary tile. Note that AppUserModelID is case-sensitive. |
|
||||||
|
| `DesktopApplicationTile`</br></br>Parent:</br>TopMFUApps | Use with the TopMFUApps tags to specify an app without a known AppUserModelID.</br></br>**Note**: Only applies to versions of Windows 10 earlier than version 1701. In Windows 10, version 1709, you can no longer pin apps to the Most Frequently Used apps list in Start. |
|
||||||
|
| `AppendOfficeSuite`</br></br>Parent:</br>LayoutModificationTemplate | Use to add the in-box installed Office suite to Start. For more information, see [Customize the Office suite of tiles](/windows-hardware/customize/desktop/customize-start-layout#customize-the-office-suite-of-tiles).</br></br>Don't use this tag with AppendDownloadOfficeTile. |
|
||||||
|
| `AppendDownloadOfficeTile`</br></br>Parent:</br>LayoutModificationTemplate | Use to add a specific **Download Office** tile to a specific location in Start</br></br>Do not use this tag with AppendOfficeSuite |
|
||||||
|
|
||||||
|
The groups have the following constraints:
|
||||||
|
|
||||||
|
- Two groups that are six columns wide, or equivalent to the width of three medium tiles
|
||||||
|
- Two medium-sized tile rows in height. Windows 10 ignores any tiles that are pinned beyond the second row.
|
||||||
|
- No limit to the number of apps that can be pinned. There's a theoretical limit of 24 tiles per group (four small tiles per medium square x 3 columns x 2 rows).
|
||||||
|
|
||||||
|
#### LayoutOptions
|
||||||
|
|
||||||
|
New devices running Windows 10 for desktop editions default to a Start menu with two columns of tiles unless boot to tablet mode is enabled. Devices with screens that are under 10" have boot to tablet mode enabled by default. For these devices, users see the full screen Start on the desktop. You can adjust the following features:
|
||||||
|
|
||||||
|
- Boot to tablet mode can be set on or off
|
||||||
|
- Set full screen Start on desktop to on or off
|
||||||
|
To do this, add the LayoutOptions element in your LayoutModification.xml file and set the FullScreenStart attribute to true or false
|
||||||
|
- Specify the number of columns in the Start menu to 1 or 2
|
||||||
|
To do this, add the LayoutOptions element in your LayoutModification.xml file and set the StartTileGroupsColumnCount attribute to 1 or 2
|
||||||
|
|
||||||
|
The following example shows how to use the LayoutOptions element to specify full screen Start on the desktop and to use one column in the Start menu:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<LayoutModificationTemplate
|
||||||
|
xmlns="http://schemas.microsoft.com/Start/2014/LayoutModification"
|
||||||
|
xmlns:defaultlayout="http://schemas.microsoft.com/Start/2014/FullDefaultLayout"
|
||||||
|
xmlns:start="http://schemas.microsoft.com/Start/2014/StartLayout"
|
||||||
|
Version="1">
|
||||||
|
<LayoutOptions
|
||||||
|
StartTileGroupsColumnCount="1"
|
||||||
|
FullScreenStart="true"
|
||||||
|
/>
|
||||||
|
</LayoutModificationTemplate>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### RequiredStartGroups
|
||||||
|
|
||||||
|
The `RequiredStartGroups` tag contains `AppendGroup` tags that represent groups that you can append to the default Start layout.
|
||||||
|
|
||||||
|
>[!IMPORTANT]
|
||||||
|
>You can add a maximum of two `AppendGroup` tags per `RequiredStartGroups` tag.
|
||||||
|
|
||||||
|
You can also assign regions to the append groups in the **RequiredStartGroups** tag's using the optional **Region** attribute or you can use the multivariant capabilities in Windows provisioning. If you're using the **Region** attribute, you must use a two-letter country code to specify the country/region that the append group(s) apply to. To specify more than one country/region, use a pipe ("|") delimiter as shown in the following example:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<RequiredStartGroups
|
||||||
|
Region="DE|ES|FR|GB|IT|US">
|
||||||
|
```
|
||||||
|
|
||||||
|
If the country/region setting for the Windows device matches a **RequiredStartGroups**, then the tiles laid out within the **RequiredStartGroups** is applied to Start.
|
||||||
|
|
||||||
|
If you specify a region-agnostic **RequiredStartGroups** (or one without the optional Region attribute), then the region-agnostic **RequiredStartGroups** is applied to Start.
|
||||||
|
|
||||||
|
### AppendGroup
|
||||||
|
|
||||||
|
**AppendGroup** tags specify a group of tiles that will be appended to Start. There is a maximum of two **AppendGroup** tags allowed per **RequiredStartGroups** tag.
|
||||||
|
|
||||||
|
For Windows 10 for desktop editions, AppendGroup tags contain start:Tile, start:DesktopApplicationTile, or start:SecondaryTile tags.
|
||||||
|
|
||||||
|
You can specify any number of tiles in an **AppendGroup**, but you can't specify a tile with a **Row** attribute greater than 1. The Start layout doesn't support overlapping tiles.
|
||||||
|
|
||||||
|
### Specify Start tiles
|
||||||
|
|
||||||
|
To pin tiles to Start, partners must use the right tile depending on what you want to pin.
|
||||||
|
|
||||||
|
#### Tile size and coordinates
|
||||||
|
|
||||||
|
All tile types require a size (`Size`) and coordinates (`Row` and `Column`) attributes, regardless of the tile type that you use when prepinning items to Start.
|
||||||
|
|
||||||
|
The following table describes the attributes that you must use to specify the size and location for the tile.
|
||||||
|
|
||||||
|
| Attribute | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `Size` | Determines how large the tile will be.</br></br>- 1x1 - small tile</br>- 2x2 - medium tile</br>- 4x2 - wide tile</br>- 4x4 - large tile |
|
||||||
|
| `Row` | Specifies the row where the tile will appear. |
|
||||||
|
| `Column` | Specifies the column where the tile will appear. |
|
||||||
|
|
||||||
|
For example, a tile with `Size="2x2"`, `Row="2"`, and `Column="2"` results in a tile located at (2,2) where (0,0) is the top-left corner of a group.
|
||||||
|
|
||||||
|
#### start:Tile
|
||||||
|
|
||||||
|
You can use the `start:Tile` tag to pin a UWP app to Start. You must set the `AppUserModelID` attribute to the application user model ID (AUMID) that's associated with the corresponding app.
|
||||||
|
|
||||||
|
#### start:DesktopApplicationTile
|
||||||
|
|
||||||
|
You can use the `start:DesktopApplicationTile` tag to pin a Windows desktop application to Start. There are two ways you can specify a Windows desktop application:
|
||||||
|
|
||||||
|
- Use a path to a shortcut link (.lnk file) to a Windows desktop application.
|
||||||
|
|
||||||
|
>[!NOTE]
|
||||||
|
>Use `DesktopApplicationID` rather than `DesktopApplicationLinkPath` if the application is installed after the user's first sign-in.
|
||||||
|
|
||||||
|
To pin a Windows desktop application through this method, you must first add the `.lnk` file in the specified location when the device first boots.
|
||||||
|
|
||||||
|
The following example shows how to pin the Command Prompt:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<start:DesktopApplicationTile
|
||||||
|
DesktopApplicationLinkPath="%appdata%\Microsoft\Windows\Start Menu\Programs\System Tools\Command Prompt.lnk"
|
||||||
|
Size="2x2"
|
||||||
|
Row="0"
|
||||||
|
Column="4"/>
|
||||||
|
```
|
||||||
|
|
||||||
|
You must set the `DesktopApplicationLinkPath` attribute to the .lnk file that points to the Windows desktop application. The path also supports environment variables.
|
||||||
|
|
||||||
|
If you are pointing to a third-party Windows desktop application and the layout is being applied before the first boot, you must put the `.lnk` file in a legacy Start Menu directory before first boot. For example, `%APPDATA%\Microsoft\Windows\Start Menu\Programs\` or the all users profile `%ALLUSERSPROFILE%\Microsoft\Windows\Start Menu\Programs\`.
|
||||||
|
|
||||||
|
- Use the AUMID, if this is known. If the Windows desktop application doesn't have one, use the shortcut link option.
|
||||||
|
|
||||||
|
Learn how to [Find the Application User Model ID of an installed app](../store/find-aumid.md).
|
||||||
|
|
||||||
|
The following example shows how to pin the File Explorer Windows desktop application:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<start:DesktopApplicationTile
|
||||||
|
DesktopApplicationID="Microsoft.Windows.Explorer"
|
||||||
|
Size="2x2"
|
||||||
|
Row="0"
|
||||||
|
Column="2"/>
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also use the `start:DesktopApplicationTile` tag as one of the methods for pinning a Web link to Start. The other method is to use a Microsoft Edge secondary tile.
|
||||||
|
|
||||||
|
To pin a legacy `.url` shortcut to Start, you must create a `.url` file (right-click on the desktop, select **New** > **Shortcut**, and then type a Web URL). You must add this `.url` file in a legacy Start Menu directory before first boot; for example, `%APPDATA%\Microsoft\Windows\Start Menu\Programs\` or the all users profile `%ALLUSERSPROFILE%\Microsoft\Windows\Start Menu\Programs\`.
|
||||||
|
|
||||||
|
The following example shows how to create a tile of the Web site's URL, which you can treat similarly to a Windows desktop application tile:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<start:DesktopApplicationTile
|
||||||
|
DesktopApplicationID="http://www.contoso.com/"
|
||||||
|
Size="2x2"
|
||||||
|
Row="0"
|
||||||
|
Column="2"/>
|
||||||
|
```
|
||||||
|
|
||||||
|
>[!NOTE]
|
||||||
|
>In Windows 10, version 1703, `Export-StartLayout` will use `DesktopApplicationLinkPath` for the .url shortcut. You must change `DesktopApplicationLinkPath` to `DesktopApplicationID` and provide the URL.
|
||||||
|
|
||||||
|
#### start:SecondaryTile
|
||||||
|
|
||||||
|
You can use the **start:SecondaryTile** tag to pin a Web link through a Microsoft Edge secondary tile. This method doesn't require any additional action compared to the method of using legacy `.url` shortcuts (through the start:DesktopApplicationTile tag).
|
||||||
|
|
||||||
|
The following example shows how to create a tile of the Web site's URL using the Microsoft Edge secondary tile:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<start:SecondaryTile
|
||||||
|
AppUserModelID="Microsoft.MicrosoftEdge_8wekyb3d8bbwe!MicrosoftEdge"
|
||||||
|
TileID="MyWeblinkTile"
|
||||||
|
Arguments="http://msn.com"
|
||||||
|
DisplayName="MySite"
|
||||||
|
Square150x150LogoUri="ms-appx:///Assets/MicrosoftEdgeSquare150x150.png"
|
||||||
|
|
||||||
|
Wide310x150LogoUri="ms-appx:///Assets/MicrosoftEdgeWide310x150.png"
|
||||||
|
ShowNameOnSquare150x150Logo="true"
|
||||||
|
ShowNameOnWide310x150Logo="false"
|
||||||
|
BackgroundColor="#FF112233"
|
||||||
|
Size="2x2"
|
||||||
|
Row="0"
|
||||||
|
Column="4"/>
|
||||||
|
```
|
||||||
|
|
||||||
|
The following table describes the other attributes that you can use with the `start:SecondaryTile` tag in addition to `Size`, `Row`, and `Column`.
|
||||||
|
|
||||||
|
| Attribute | Required/optional | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| AppUserModelID | Required | Must point to Microsoft Edge. Note that AppUserModelID is case-sensitive. |
|
||||||
|
| TileID | Required | Must uniquely identify your Web site tile. |
|
||||||
|
| Arguments | Required | Must contain the URL of your Web site. |
|
||||||
|
| DisplayName | Required | Must specify the text that you want users to see. |
|
||||||
|
| Square150x150LogoUri | Required | Specifies the logo to use on the 2x2 tile. |
|
||||||
|
| Wide310x150LogoUri | Optional | Specifies the logo to use on the 4x2 tile. |
|
||||||
|
| ShowNameOnSquare150x150Logo | Optional | Specifies whether the display name is shown on the 2x2 tile. The values you can use for this attribute are true or false. |
|
||||||
|
| ShowNameOnWide310x150Logo | Optional | Specifies whether the display name is shown on the 4x2 tile. The values you can use for this attribute are true or false. |
|
||||||
|
| BackgroundColor | Optional | Specifies the color of the tile. You can specify the value in ARGB hexadecimal (for example, #FF112233) or specify "transparent". |
|
||||||
|
| ForegroundText | Optional | Specifies the color of the foreground text. Set the value to either "light" or "dark". |
|
||||||
|
|
||||||
|
Secondary Microsoft Edge tiles have the same size and location behavior as a Universal Windows app, Windows 8 app, or Windows 8.1 app.
|
||||||
|
|
||||||
|
#### AppendOfficeSuite
|
||||||
|
|
||||||
|
You can use the `AppendOfficeSuite` tag to add the in-box installed Office suite of apps to Start.
|
||||||
|
|
||||||
|
>[!NOTE]
|
||||||
|
>The OEM must have installed Office for this tag to work.
|
||||||
|
|
||||||
|
The following example shows how to add the `AppendOfficeSuite` tag to your `LayoutModification.xml` file to append the full Universal Office suite to Start:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<LayoutModificationTemplate
|
||||||
|
xmlns="http://schemas.microsoft.com/Start/2014/LayoutModification"
|
||||||
|
xmlns:defaultlayout="http://schemas.microsoft.com/Start/2014/FullDefaultLayout"
|
||||||
|
xmlns:start="http://schemas.microsoft.com/Start/2014/StartLayout"
|
||||||
|
Version="1">
|
||||||
|
<AppendOfficeSuite/>
|
||||||
|
</LayoutModificationTemplate>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### AppendOfficeSuiteChoice
|
||||||
|
|
||||||
|
This tag is added in Windows 10, version 1801. You have two options in this tag:
|
||||||
|
|
||||||
|
- `<AppendOfficeSuiteChoice Choice="DesktopBridgeSubscription"/>`
|
||||||
|
- `<AppendOfficeSuiteChoice Choice="DesktopBridge"/>`
|
||||||
|
|
||||||
|
Use `Choice=DesktopBridgeSubscription` on devices running Windows 10, version 1803, that have Office 365 preinstalled. This will set the heading of the Office suite of tiles to **Office 365**, to highlight the Office 365 apps that you've made available on the device.
|
||||||
|
|
||||||
|
Use `Choice=DesktopBridge` on devices running versions of Windows 10 earlier than version 1803, and on devices shipping with [perpetual licenses for Office](/archive/blogs/ausoemteam/choosing-the-right-office-version-for-your-customers). This will set the heading of the Office suite of tiles to **Create**.
|
||||||
|
|
||||||
|
For more information, see [Customize the Office suite of tiles](/windows-hardware/customize/desktop/customize-start-layout#customize-the-office-suite-of-tiles).
|
||||||
|
|
||||||
|
#### AppendDownloadOfficeTile
|
||||||
|
|
||||||
|
You can use the **AppendDownloadOfficeTile** tag to append the Office trial installer to Start. This tag adds the **Download Office** tile to Start and the download tile will appear at the bottom right-hand side of the second group.
|
||||||
|
|
||||||
|
>[!NOTE]
|
||||||
|
>The OEM must have installed the Office trial installer for this tag to work.
|
||||||
|
|
||||||
|
The following example shows how to add the **AppendDownloadOfficeTile** tag to your LayoutModification.xml file:
|
||||||
|
|
||||||
|
```XML
|
||||||
|
<LayoutModificationTemplate
|
||||||
|
xmlns="http://schemas.microsoft.com/Start/2014/LayoutModification"
|
||||||
|
xmlns:defaultlayout="http://schemas.microsoft.com/Start/2014/FullDefaultLayout"
|
||||||
|
xmlns:start="http://schemas.microsoft.com/Start/2014/StartLayout"
|
||||||
|
Version="1">
|
||||||
|
<AppendDownloadOfficeTile/>
|
||||||
|
</LayoutModificationTemplate>
|
||||||
|
```
|
||||||
|
|
||||||
#### Configure a partial Start layout
|
#### Configure a partial Start layout
|
||||||
|
|
||||||
:::row:::
|
:::row:::
|
||||||
@ -241,6 +487,8 @@ Alternatively, you can configure devices using a [custom policy][MEM-1] with the
|
|||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> The content of the file must be entered as a single line in the `Value` field. Use a text editor to remove any line breaks from the XML file, usually with a function called *join lines*.
|
> The content of the file must be entered as a single line in the `Value` field. Use a text editor to remove any line breaks from the XML file, usually with a function called *join lines*.
|
||||||
|
|
||||||
|
[!INCLUDE [provisioning-package-2](../../../includes/configure/provisioning-package-2.md)]
|
||||||
|
|
||||||
### Use Windows Provisioning multivariant support
|
### Use Windows Provisioning multivariant support
|
||||||
|
|
||||||
The Windows Provisioning multivariant capability allows you to declare target conditions that, when met, supply specific customizations for each variant condition. For Start customization, you can create specific layouts for each variant that you have. To do this, you must create a separate LayoutModification.xml file for each variant that you want to support and then include these in your provisioning package. For more information on how to do this, see [Create a provisioning package with multivariant settings](../provisioning-packages/provisioning-multivariant.md).
|
The Windows Provisioning multivariant capability allows you to declare target conditions that, when met, supply specific customizations for each variant condition. For Start customization, you can create specific layouts for each variant that you have. To do this, you must create a separate LayoutModification.xml file for each variant that you want to support and then include these in your provisioning package. For more information on how to do this, see [Create a provisioning package with multivariant settings](../provisioning-packages/provisioning-multivariant.md).
|
||||||
@ -309,8 +557,6 @@ When the condition is met, the provisioning engine takes the XML file and places
|
|||||||
|
|
||||||
You must repeat this process for all variants that you want to support so that each variant can have a distinct layout for each of the conditions and targets that need to be supported. For example, if you add a `Language` condition, you can create a Start layout that has its own localized group.
|
You must repeat this process for all variants that you want to support so that each variant can have a distinct layout for each of the conditions and targets that need to be supported. For example, if you add a `Language` condition, you can create a Start layout that has its own localized group.
|
||||||
|
|
||||||
[!INCLUDE [provisioning-package-2](../../../includes/configure/provisioning-package-2.md)]
|
|
||||||
|
|
||||||
#### [:::image type="icon" source="../images/icons/group-policy.svg"::: **GPO**](#tab/gpo)
|
#### [:::image type="icon" source="../images/icons/group-policy.svg"::: **GPO**](#tab/gpo)
|
||||||
|
|
||||||
To configure a device with group policy, use the [Local Group Policy Editor](/previous-versions/windows/it-pro/windows-server-2008-r2-and-2008/cc731745(v=ws.10)). To configure multiple devices joined to Active Directory, [create or edit](/previous-versions/windows/it-pro/windows-server-2008-r2-and-2008/cc754740(v=ws.11)) a group policy object (GPO) and use one of the following settings:
|
To configure a device with group policy, use the [Local Group Policy Editor](/previous-versions/windows/it-pro/windows-server-2008-r2-and-2008/cc731745(v=ws.10)). To configure multiple devices joined to Active Directory, [create or edit](/previous-versions/windows/it-pro/windows-server-2008-r2-and-2008/cc754740(v=ws.11)) a group policy object (GPO) and use one of the following settings:
|
||||||
|
@ -8,7 +8,5 @@ items:
|
|||||||
href: policy-settings.md
|
href: policy-settings.md
|
||||||
- name: XML schema definition (XSD)
|
- name: XML schema definition (XSD)
|
||||||
href: xsd.md
|
href: xsd.md
|
||||||
- name: _🧐 XML schema
|
|
||||||
href: _delete.md
|
|
||||||
- name: Troubleshoot Start menu errors 🔗
|
- name: Troubleshoot Start menu errors 🔗
|
||||||
href: /troubleshoot/windows-client/shell-experience/troubleshoot-start-menu-errors
|
href: /troubleshoot/windows-client/shell-experience/troubleshoot-start-menu-errors
|
||||||
|
Loading…
x
Reference in New Issue
Block a user