Skip to content

Commit 5e7a8c8

Browse files
committed
Content review updates
1 parent 1fa33b2 commit 5e7a8c8

8 files changed

+15
-15
lines changed

docs/extensibility/adding-a-submenu-to-a-menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ This walkthrough builds on the demonstration in [Add a Menu to the Visual Studio
121121
}
122122
```
123123

124-
3. Add SubItemCallback(). This is the method that is called when the new command in the submenu is clicked.
124+
3. Add `SubItemCallback()`. This is the method that is called when the new command in the submenu is clicked.
125125

126126
```csharp
127127
private void SubItemCallback(object sender, EventArgs e)

docs/extensibility/adding-a-toolbar-to-a-tool-window.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,4 @@ This walkthrough shows how to add a toolbar to a tool window.
111111
3. On the toolbar, click the icon to display the message **TWTestCommandPackage Inside TWToolbar.TWTestCommand.MenuItemCallback()**.
112112

113113
## See also
114-
[Adding a toolbar](../extensibility/adding-a-toolbar.md)
114+
[Add a toolbar](../extensibility/adding-a-toolbar.md)

docs/extensibility/adding-icons-to-menu-commands.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ Commands can appear on both menus and toolbars. On toolbars, it is common for a
3030

3131
If you use an 8-bit color depth, use magenta, `RGB(255,0,255)`, as the transparency. However, 32-bit color icons are preferred.
3232

33-
2. Copy the icon file to the *Resources* directory in your VSPackage project. In the Solution Explorer, add the icon to the project. (Select **Resources**, and on the context menu click **Add**, then **Existing Item**, and select your icon file.)
33+
2. Copy the icon file to the *Resources* directory in your VSPackage project. In the **Solution Explorer**, add the icon to the project. (Select **Resources**, and on the context menu click **Add**, then **Existing Item**, and select your icon file.)
3434

3535
3. Open the *.vsct* file in the editor.
3636

37-
4. Add a `GuidSymbol` element with a name of **testIcon**. Create a GUID (**Tools / Create GUID**, then select **Registry Format** and click **Copy**) and paste it into the `value` attribute. The result should look like this:
37+
4. Add a `GuidSymbol` element with a name of **testIcon**. Create a GUID (**Tools** > **Create GUID**, then select **Registry Format** and click **Copy**) and paste it into the `value` attribute. The result should look like this:
3838

3939
```xml
4040
<!-- Create your own GUID -->

docs/extensibility/adding-user-control-to-the-start-page.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This walkthrough shows how to add a DLL reference to a custom Start Page. The ex
3737

3838
### To write the XAML for the user control
3939

40-
1. Open the XAML file for the user control. In the \<Grid> element, add the following row definitions to the control.
40+
1. Open the XAML file for the user control. In the `Grid` element, add the following row definitions to the control.
4141

4242
```vb
4343
<Grid.RowDefinitions>
@@ -99,7 +99,7 @@ This walkthrough shows how to add a DLL reference to a custom Start Page. The ex
9999

100100
1. In the XAML designer, double-click the **Set Address** button you added to the control.
101101

102-
The UserControl1.cs file opens in the code editor.
102+
The *UserControl1.cs* file opens in the code editor.
103103

104104
2. Fill in the SetButton_Click Event Handler as follows.
105105

@@ -175,7 +175,7 @@ This walkthrough shows how to add a DLL reference to a custom Start Page. The ex
175175

176176
3. At a Visual Studio command prompt, type **devenv /rootsuffix Exp** to open an experimental instance of Visual Studio.
177177

178-
4. In the experimental instance, go to the **Tools / Options / Environment / Startup** page and select your XAML file from the **Customize Start Page** dropdown.
178+
4. In the experimental instance, go to the **Tools** > **Options** > **Environment** > **Startup** page and select your XAML file from the **Customize Start Page** dropdown.
179179

180180
5. On the **View** menu, click **Start Page**.
181181

docs/extensibility/addressing-dpi-issues2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ An increasing number of devices are shipping with "high-resolution" screens. The
5656
(WinForms) DpiHelper.LogicalToDeviceUnits(ref image);
5757
```
5858

59-
Scaling an imagelist depends on whether the imagelist is complete at load time, or is appended at run time. If complete at load time, call LogicalToDeviceUnits() with the imagelist as you would a bitmap. When the code needs to load an individual bitmap before composing the imagelist, make sure to scale the image size of the imagelist:
59+
Scaling an imagelist depends on whether the imagelist is complete at load time, or is appended at run time. If complete at load time, call `LogicalToDeviceUnits()` with the imagelist as you would a bitmap. When the code needs to load an individual bitmap before composing the imagelist, make sure to scale the image size of the imagelist:
6060

6161
```csharp
6262
imagelist.ImageSize = DpiHelper.LogicalToDeviceUnits(imagelist.ImageSize);
@@ -100,7 +100,7 @@ ImageList_Create(VsUI::DpiHelper::LogicalToDeviceUnitsX(16),VsUI::DpiHelper::Log
100100
101101
To use the library, go to the [Visual Studio VSSDK extensibility samples](https://github.com/Microsoft/VSSDK-Extensibility-Samples) and clone the High-DPI_Images_Icons sample.
102102
103-
In source files, include *VsUIDpiHelper.h* and call the static functions of VsUI::DpiHelper class:
103+
In source files, include *VsUIDpiHelper.h* and call the static functions of `VsUI::DpiHelper` class:
104104
105105
```cpp
106106
#include "VsUIDpiHelper.h"
@@ -322,7 +322,7 @@ customDoc.SetUIHandler(this);
322322

323323
```
324324

325-
If you did NOT implement the ICustomDoc interface, then as soon as the WebOC's document property is valid, you'll need to cast it to an IOleObject, and call the SetClientSite method, passing in the class that implements IDocHostUIHandler. Set the DOCHOSTUIFLAG_DPI_AWARE flag on the DOCHOSTUIINFO passed to the GetHostInfo method call:
325+
If you did NOT implement the ICustomDoc interface, then as soon as the WebOC's document property is valid, you'll need to cast it to an IOleObject, and call the `SetClientSite` method, passing in the class that implements IDocHostUIHandler. Set the DOCHOSTUIFLAG_DPI_AWARE flag on the DOCHOSTUIINFO passed to the `GetHostInfo` method call:
326326

327327
```csharp
328328
public int GetHostInfo(DOCHOSTUIINFO info)

docs/extensibility/best-practices-for-implementing-a-source-control-plug-in.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The following technical details can help you reliably implement a source control
4040
## Error result codes and reporting
4141
The `SCC_OK` return code for a source control function indicates that the operation has succeeded for all files. If the operation fails, it is expected to return the last error code encountered.
4242

43-
The rule for reporting is that if an error occurs in the IDE, the IDE is responsible for reporting it. If an error occurs in the source control system, the source control plug-in is responsible for reporting it. For instance, "No files are currently selected" would be reported by the IDE, whereas "This file is already checked out" would be reported by the plug-in.
43+
The rule for reporting is that if an error occurs in the IDE, the IDE is responsible for reporting it. If an error occurs in the source control system, the source control plug-in is responsible for reporting it. For instance, **No files are currently selected** would be reported by the IDE, whereas **This file is already checked out** would be reported by the plug-in.
4444

4545
## The context structure
4646
During the call to the [SccInitialize](../extensibility/sccinitialize-function.md), the caller passes the `ppvContext` parameter, which is an uninitialized handle to a void. The source control plug-in can ignore this parameter or it can allocate a structure of any kind and put a pointer to that structure into the passed pointer. The IDE does not understand this structure, but it passes a pointer to this structure into every other call in the plug-in. This provides valuable context cache information to the plug-in that it can use to maintain global state information that persists across function calls without using global variables. The plug-in is responsible for freeing the structure on a call to the [SccUninitialize](../extensibility/sccuninitialize-function.md).
@@ -50,7 +50,7 @@ The following technical details can help you reliably implement a source control
5050
## Bitflags and other command options
5151
For each command, such as the [SccGet](../extensibility/sccget-function.md), the IDE can specify many options that change the behavior of the command.
5252

53-
The API supports the setting of certain options by the IDE through the `fOptions` parameter. These options are described in [Bitflags Used by Specific Commands](../extensibility/bitflags-used-by-specific-commands.md) together with the commands that they affect. In general, these are options for which the user would not be prompted.
53+
The API supports the setting of certain options by the IDE through the `fOptions` parameter. These options are described in [Bitflags used by specific commands](../extensibility/bitflags-used-by-specific-commands.md) together with the commands that they affect. In general, these are options for which the user would not be prompted.
5454

5555
Most user-configurable setting options are not defined in this manner, because they vary widely among source control plug-ins. Therefore, the recommended mechanism is an **Advanced** button. For instance, in the **Get** dialog box, the IDE displays only information that it understands, but it also displays an **Advanced** button if the plug-in has options for this command. When the user clicks the **Advanced** button, the IDE calls the [SccGetCommandOptions](../extensibility/sccgetcommandoptions-function.md) to enable the source control plug-in to prompt the user for information, such as bitflags or a date/time. The plug-in returns this information in a structure that is passed back during the `SccGet` command.
5656

docs/extensibility/binding-keyboard-shortcuts-to-menu-items.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ To bind a keyboard shortcut to a custom menu command, just add an entry to the *
2828

2929
### To verify the availability of a keyboard shortcut
3030

31-
1. In the **Tools / Options / Environment** window, select **Keyboard**.
31+
1. In the **Tools** > **Options** > **Environment** window, select **Keyboard**.
3232

3333
2. Make sure that **Use new shortcut in** is set to **Global**.
3434

3535
3. In the **Press shortcut keys** box, type the keyboard shortcut that you want to use.
3636

37-
If the shortcut is already used in Visual Studio, the **Shorcut currently used by** box will show the command that the shortcut currently calls.
37+
If the shortcut is already used in Visual Studio, the **Shortcut currently used by** box will show the command that the shortcut currently calls.
3838

3939
4. Try different combinations of keys until you find one that is not mapped.
4040

docs/extensibility/buildprojectonload-element-visual-studio-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Builds only new projects as you create and add them to a solution. The entire so
3838

3939
|Element|Description|
4040
|-------------|-----------------|
41-
|TemplateData|Categorizes the template and defines how it appears in both the **New Project** and the **Add New Item** dialog boxes.|
41+
|`TemplateData`|Categorizes the template and defines how it appears in both the **New Project** and the **Add New Item** dialog boxes.|
4242

4343
## Text value
4444
A text value is required.

0 commit comments

Comments
 (0)