Skip to content

Commit 58216f0

Browse files
ghogenghogen
committed
Fix up shell TOC with new design
1 parent d5b37e6 commit 58216f0

File tree

36 files changed

+1635
-17
lines changed

36 files changed

+1635
-17
lines changed

‎docs/extensibility/TOC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
## [How to: Use Rule-based UI Context for Visual Studio Extensions](how-to-use-rule-based-ui-context-for-visual-studio-extensions.md)
187187
## [How to: Diagnose extension performance](how-to-diagnose-extension-performance.md)
188188
## [Troubleshooting VSPackages](troubleshooting-vspackages.md)
189-
# [Shell (Integrated or Isolated)](shell-extensibility/shell-isolated-or-integrated.md)
189+
# [Shell (Integrated or Isolated)](shell/)
190190
# [Shipping Visual Studio Extensions](shipping-visual-studio-extensions.md)
191191
## [VSIX Project Template](vsix-project-template.md)
192192
## [Getting Started with the VSIX Project Template](getting-started-with-the-vsix-project-template.md)

‎docs/extensibility/customizing-the-isolated-shell.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/customizing-the-isolated-shell
23
title: "Customizing the Isolated Shell | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/distributing-isolated-shell-applications.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/distributing-isolated-shell-applications
23
title: "Distributing Isolated Shell Applications | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/elements-of-the-isolated-shell.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/elements-of-the-isolated-shell
23
title: "Elements of the Isolated Shell | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/extending-the-isolated-shell.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/extending-the-isolated-shell
23
title: "Extending the Isolated Shell | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/installing-an-isolated-shell-application.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/installing-an-isolated-shell-application
23
title: "Installing an Isolated Shell Application | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/isolated-shell-entry-point-parameters-cpp.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/isolated-shell-entry-point-parameters-cpp
23
title: "Isolated Shell Entry Point Parameters (C++) | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/modifying-the-isolated-shell-by-using-the-dot-pkgdef-file.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/modifying-the-isolated-shell-by-using-the-dot-pkgdef-file
23
title: "Modifying the Isolated Shell By Using the .Pkgdef File | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/modifying-the-isolated-shell-by-using-the-dot-pkgundef-file.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/modifying-the-isolated-shell-by-using-the-dot-pkgundef-file
23
title: "Modifying the Isolated Shell By Using the .Pkgundef File | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/modifying-the-isolated-shell-by-using-the-dot-vsct-file.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/modifying-the-isolated-shell-by-using-the-dot-vsct-file
23
title: "Modifying the Isolated Shell By Using the .Vsct File | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/package-guids-of-visual-studio-features.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/package-guids-of-visual-studio-features
23
title: "Package GUIDs of Visual Studio Features | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/servicing-guidelines-for-isolated-shell-applications.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/servicing-guidelines-for-isolated-shell-applications
23
title: "Servicing Guidelines for Isolated Shell Applications | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/shell-extensibility/TOC.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎docs/extensibility/shell-isolated-or-integrated.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
redirect_url: shell/shell-isolated-or-integrated
23
title: "Shell (Isolated or Integrated) | Microsoft Docs"
34
ms.custom: ""
45
ms.date: "11/04/2016"

‎docs/extensibility/shell/TOC.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# [Shell (Isolated or Integrated)](shell-isolated-or-integrated.md)
2+
## [Visual Studio Isolated Shell](visual-studio-isolated-shell.md)
3+
### [Walkthrough: Creating a Basic Isolated Shell Application](walkthrough-creating-a-basic-isolated-shell-application.md)
4+
### [Customizing the Isolated Shell](customizing-the-isolated-shell.md)
5+
### [Extending the Isolated Shell](extending-the-isolated-shell.md)
6+
### [Elements of the Isolated Shell](elements-of-the-isolated-shell.md)
7+
#### [Modifying the Isolated Shell By Using the .Vsct File](modifying-the-isolated-shell-by-using-the-dot-vsct-file.md)
8+
#### [Modifying the Isolated Shell By Using the .Pkgundef File](modifying-the-isolated-shell-by-using-the-dot-pkgundef-file.md)
9+
#### [Modifying the Isolated Shell By Using the .Pkgdef File](modifying-the-isolated-shell-by-using-the-dot-pkgdef-file.md)
10+
#### [Substitution Strings Used in .Pkgdef and .Pkgundef Files](substitution-strings-used-in-dot-pkgdef-and-dot-pkgundef-files.md)
11+
#### [Isolated Shell Entry Point Parameters (C++)](isolated-shell-entry-point-parameters-cpp.md)
12+
#### [Package GUIDs of Visual Studio Features](package-guids-of-visual-studio-features.md)
13+
## [Visual Studio Shell (Integrated)](visual-studio-shell-integrated.md)
14+
## [Distributing Isolated Shell Applications](distributing-isolated-shell-applications.md)
15+
### [Installing an Isolated Shell Application](installing-an-isolated-shell-application.md)
16+
### [Servicing Guidelines for Isolated Shell Applications](servicing-guidelines-for-isolated-shell-applications.md)

‎docs/extensibility/shell/customizing-the-isolated-shell.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
title: "Customizing the Isolated Shell | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.reviewer: ""
6+
ms.suite: ""
7+
ms.technology:
8+
- "vs-ide-sdk"
9+
ms.tgt_pltfrm: ""
10+
ms.topic: "article"
11+
helpviewer_keywords:
12+
- "Visual Studio shell, isolated mode"
13+
ms.assetid: e0b7c3ae-210f-4f48-ac49-6a59e6034f5f
14+
caps.latest.revision: 15
15+
ms.author: "gregvanl"
16+
manager: "ghogen"
17+
---
18+
# Customizing the Isolated Shell
19+
You can customize your Visual Studio isolated shell application by changing different aspects of the Visual Studio user interface and by restricting the commands and features included in your specialized application.
20+
21+
## Using the Application.pkgdef file
22+
The isolated shell template solution includes a *SolutionName*.Application.pkgdef file that allows you to modify the following features:
23+
24+
##### The application title
25+
You can customize the application title, which is the name that is displayed in the title bar of the application, by changing the value of the "AppName" row in the *SolutionName*.Application.pkgdef file. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md).
26+
27+
If you do not want the application title to display the project that is currently loaded, change the value of the "ShowHierarchyRootInTitle" row in the *SolutionName*.Application.pkgdef file from dword:00000001 to dword:00000000.
28+
29+
##### The application icon
30+
You can customize the application icon, which is the icon that is displayed by the application name in the application title bar. Copy a different icon to the icon directory. In **Solution Explorer**, add the icon to the Resource Files folder. Then open the VSShellStub.rc file and replace the value of IDI_STUBPROGRAM with the name of the new icon. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md).
31+
32+
##### The command-line logo
33+
You can customize the command-line logo, which is the text that appears when the application is started from the command line, by changing the value of the "CommandLineLogo" row in the *SolutionName*.Application.pkgdef file. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md)
34+
35+
##### The name of the user files subfolder
36+
You can change the name of the folder your application maintains for user files by changing the value of the "UserFilesSubFolderName" row in *SolutionName*.Application.pkgdef file.
37+
38+
##### The title of the solution tree node in the New Project dialog
39+
You can customize the title of the solution node in the New Project dialog by changing the value of the "NewProjDlgSlnTreeNodeTitle" row in the *SolutionName*.Application.pkgdef file.
40+
41+
##### The installed templates header in the New Project dialog
42+
You can change the installed templates header in the New Project dialog by changing the value of the "NewProjDlgInstalledTemplatesHdr" row in the *SolutionName*.Application.pkgdef file.
43+
44+
##### Whether or not to hide Miscellaneous files by default
45+
You can specify whether or not to hide Miscellaneous files by default by changing the value of the "HideMiscellaneousFilesByDefault" row in the *SolutionName*.Application.pkgdef file. To hide Miscellaneous files, set the value `dword:00000001`, and to show the files, set the value `dword:00000000`.
46+
47+
##### Whether or not to disable the output window
48+
You can specify whether or not to disable the output window in your application by changing the value of the "DisableOutputWindow" row in the *SolutionName*.Application.pkgdef file. To disable the output window, set the value `dword:00000001`, and to show the output window, set the value `dword:00000000`.
49+
50+
##### Whether or not to allow dropped files on the main window
51+
You can specify whether or not to allow dropped files on the main window in your application by changing the value of the "AllowsDroppedFilesOnMainWindow" row in the *SolutionName*.Application.pkgdef file. To allow dropped files, set the value `dword:00000001`, and to disallow dropped files, set the value `dword:00000000`.
52+
53+
##### The default search page
54+
You can customize the web browser page, which is page that is displayed when the web browser window is opened, by changing the value of the "DefaultSearchPage" row in the *SolutionName*.Application.pkgdef file.
55+
56+
##### The default home page
57+
You can customize the home page by changing the value of the "DefaultHomePage" row in the *SolutionName*.Application.pkgdef file. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md)
58+
59+
##### Whether or not to hide the solution concept
60+
You can specify whether or not to hide the solution in your application by changing the value of the "HideSolutionConcept" row in the *SolutionName*.Application.pkgdef file. To hide the solution, set the value `dword:00000001`, and to show the solution, set the value `dword:00000000`.
61+
62+
##### The default debug engine
63+
You can change the debug engine your application uses by changing the value of the "DefaultDebugEngine" row in the *SolutionName*.Application.pkgdef file to the GUID of your debug engine.
64+
65+
##### The file extension of the user options file
66+
You can change the name of the folder your application maintains for user files by changing the value of the "UserOptsFileExt" row in *SolutionName*.Application.pkgdef file.
67+
68+
##### The solution file extension
69+
You can change the extension used for your solution files by changing the value of the "SolutionFileExt" row in the *SolutionName*.Application.pkgdef file.
70+
71+
##### The default user files folder root
72+
You can change the name of the root folder of the user files for your application by changing the value of the "UserFilesSubFolderName" row in the *SolutionName*.Application.pkgdef file.
73+
74+
##### The solution file creator identifier
75+
You can change the identifier used for your solution files by changing the value of the "SolutionFileCreatorIdentifier" row in the *SolutionName*.Application.pkgdef file.
76+
77+
##### The default projects location
78+
You can change the name of the default projects location by changing the value of the "DefaultProjectsLocation" row in the *SolutionName*.Application.pkgdef file.
79+
80+
##### The application localization package
81+
You can change the localization package used for your application by changing the value of the "AppLocalizationPackage" row in the *SolutionName*.Application.pkgdef file.
82+
83+
##### Whether or not to show the hierarchy root in the title
84+
You can specify whether or not to show the hierarchy root in the title bar in your application by changing the value of the "ShowHierarchyRootInTitle" row in the *SolutionName*.Application.pkgdef file. To show the hierarchy root, set the value `dword:00000001`, and to hide the hierarchy root, set the value `dword:00000000`.
85+
86+
##### Specifying a start page
87+
To specify a start page for your custom application, in the *SolutionName*.Application.pkgdef file, set the "DisableStartPage" value to `dword:00000000`, and under `[$RootKey$\StartPage\Default]` set the URI to the location of the .xaml file:
88+
89+
```
90+
DisableStartPage=dword:00000000
91+
[$RootKey$\StartPage\Default]
92+
"Uri"="$RootFolder$\<name of XAML file>"
93+
```
94+
95+
In the Applicationcommands.vsct file in the *SolutionName*UI project, comment out the "No_ShellPkg_startPageCommand" entry:
96+
97+
```
98+
<!--<Define name="No_ShellPkg_StartPageCommand"/>-->
99+
```
100+
101+
You must add the .xaml file, and any graphics files you need, to the *SolutionName* project. These files must actually be copied to the *SolutionName* project directory, not added from some other directory.
102+
103+
On all the files, set the **Item Type** property to **Isolated Shell File** in order for the files to be copied to the *$RootFolder$* directory. (To set the **Item Type** property, right-click the file and select **Properties**. This property is found under **Configuration Properties**, **General**.)
104+
105+
For more information on customizing start pages, see [Customizing the Start Page](../ide/customizing-the-start-page-for-visual-studio.md).
106+
107+
## Using other elements of the isolated shell
108+
You can use other files and projects that are included in the isolated shell solution template to further customize your application.
109+
110+
##### Enable/disable Visual Studio packages
111+
The *SolutionName*.pkgundef file allows you to disable certain kinds of Visual Studio functionality by excluding certain packages. For example, the following line:
112+
113+
```
114+
[$RootKey$\Projects\{A2FE74E1-B743-11d0-AE1A-00A0C90FFFC3}\AddItemTemplates\TemplateDirs\{39c9c826-8ef8-4079-8c95-428f5b1c323f}]
115+
```
116+
117+
removes the Miscellaneous Files project from the set of project templates displayed in the **New Project** dialog. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md).
118+
119+
##### Enable/disable menu commands
120+
The *SolutionName*UI.vsct file includes a commented-out list of all the menu commands available to the isolated shell. To disable a given command, uncomment the corresponding row. For example, to disable the Window/Split comment, uncomment the `<Define name="No_SplitCommand"/>` row. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md).
121+
122+
##### The bitmap used on the splash screen
123+
You can customize the bitmap used on the splash screen, which is the window that is displayed when the application is started, by changing the value of the "SplashScreenBitmap" row in the *SolutionName*.Application.pkgdef file. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md).
124+
125+
##### The Help/About window
126+
In the isolated shell template there is a separate project you can use to customize the Help/About box for your application. For more details, see [Walkthrough: Creating a Basic Isolated Shell Application](../extensibility/walkthrough-creating-a-basic-isolated-shell-application.md).

‎docs/extensibility/shell/distributing-isolated-shell-applications.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Distributing Isolated Shell Applications | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.reviewer: ""
6+
ms.suite: ""
7+
ms.technology:
8+
- "vs-ide-sdk"
9+
ms.tgt_pltfrm: ""
10+
ms.topic: "article"
11+
ms.assetid: c503a985-d67a-4ef8-9123-7744a78f2f17
12+
caps.latest.revision: 9
13+
ms.author: "gregvanl"
14+
manager: "ghogen"
15+
---
16+
# Distributing Isolated Shell Applications
17+
You must install Visual Studio and the Visual Studio SDK in order to create an isolated shell application. To distribute the application to the machines of other users or customers, you must include a special redistributable package for the isolated shell.
18+
19+
## Prerequisites for Distributing Isolated Shell Applications
20+
21+
|Name|Description|
22+
|----------|-----------------|
23+
|Visual Studio SDK|The SDK you must have to develop and test extensions of [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)]. You can also use the SDK to create your own instance of the Visual Studio isolated shell.<br /><br /> Visual Studio is a prerequisite for the SDK.|
24+
|Microsoft Visual Studio Isolated Shell Redistributable|The redistributable that you include in your Setup program when you build a tools environment on the Visual Studio isolated shell. The isolated Shell redistributable package includes the .NET Framework 4.5.|
25+
26+
## Creating an Installation Program for the Application
27+
You must create a special installation program for your integrated or isolated shell application. For more information, see [Installing an Isolated Shell Application](../extensibility/installing-an-isolated-shell-application.md).
28+
29+
## Allowing for Updates to your Application
30+
Your installation program must allow for the possibility that your application will be updated, either by Microsoft updates or by your company's updates. For more information about updates, see [Servicing Guidelines for Isolated Shell Applications](../extensibility/servicing-guidelines-for-isolated-shell-applications.md).

0 commit comments

Comments
 (0)