Skip to content

Commit cefe8f5

Browse files
author
Kraig Brockschmidt
committed
Improve generic references to package/assembly
1 parent 859b29a commit cefe8f5

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/Guides/Create-UWP-Controls.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,14 @@ The structure of the file is as follows:
6666

6767
where:
6868

69-
- *your_package_file*: the name of your control file, such as `ManagedPackage.winmd`.
69+
- *your_package_file*: the name of your control file, such as `ManagedPackage.winmd` ("ManagedPackage" is an arbitrary named used for this example and has no other meaning).
7070
- *vs_category*: The label for the group in which the control should appear in the Visual Studio designer’s toolbox. A `VSCategory` is necessary for the control to appear in the toolbox.
7171
- *blend_category*: The label for the group in which the control should appear in the Blend designer’s Assets pane. A `BlendCategory` is necessary for the control to appear in Assets.
7272
- *type_full_name_n*: The fully-qualified name for each control, including the namespace, such as `ManagedPackage.MyCustomControl`. Note that the dot format is used for both managed and native types.
7373

7474
In more advanced scenarios, you can also include multiple `<File>` elements within `<FileList>` when a single package contains multiple control assemblies. You can also have multiple `<ToolboxItems>` nodes within a single `<File>` if you want to organize your controls into separate categories.
7575

76-
In the following example, the control implemented in `ManagedPackage.winmd` will appear in Visual Studio and Blend in a group named “Managed Package”, and “MyCustomControl” will appear in that group.
76+
In the following example, the control implemented in `ManagedPackage.winmd` will appear in Visual Studio and Blend in a group named “Managed Package”, and “MyCustomControl” will appear in that group. All these names are arbitrary.
7777

7878
```xml
7979
<FileList>
@@ -143,12 +143,12 @@ For example, let’s say you’ve set the TPMinV for you controls package to Win
143143
\ref\uap10.0\*
144144
```
145145

146-
To enforce the appropriate TPMinV check, create an [MSBuild targets file](https://docs.microsoft.com/visualstudio/msbuild/msbuild-targets) and package it under the build folder:
146+
To enforce the appropriate TPMinV check, create an [MSBuild targets file](https://docs.microsoft.com/visualstudio/msbuild/msbuild-targets) and package it under the build folder (replacing "your_assembly_name" with the name of your specific assembly):
147147

148148
```
149149
\build
150150
\uap10.0
151-
MyManagedPackage.targets
151+
your_assembly_name.targets
152152
\lib
153153
\tools
154154
```
@@ -174,15 +174,16 @@ Here is an example of what the targets file should look like:
174174

175175
## Add design-time support
176176

177-
To configure where the control properties show up in the property inspector, add custom adorners, etc., place your `design.dll` file inside the `lib\<platform>\Design` folder as appropriate to the target platform:
177+
To configure where the control properties show up in the property inspector, add custom adorners, etc., place your `design.dll` file inside the `lib\<platform>\Design` folder as appropriate to the target platform. Also, to ensure that the **[Edit Template > Edit a Copy](https://docs.microsoft.com/windows/uwp/controls-and-patterns/xaml-styles#modify-the-default-system-styles)** feature works, you must include the `Generic.xaml` and any resource dictionaries that it merges in the `<AssemblyName>\Themes` folder. (This file has no impact on the runtime behavior of a control.)
178+
178179

179180
```
180181
\build
181182
\lib
182183
\uap10.0.14393.0
183184
\Design
184185
\MyControl.design.dll
185-
\ManagedPackage
186+
\your_assembly_name
186187
\Themes
187188
Generic.xaml
188189
\tools
@@ -191,7 +192,6 @@ To configure where the control properties show up in the property inspector, add
191192
> [!Note]
192193
> By default, control properties will show up under the Miscellaneous category in the property inspector.
193194
194-
To ensure that the **[Edit Template > Edit a Copy](https://docs.microsoft.com/windows/uwp/controls-and-patterns/xaml-styles#modify-the-default-system-styles)** feature works, you must include the `Generic.xaml` and any resource dictionaries that it merges in the `<AssemblyName>\Themes` folder.
195195

196196
## Use strings and resources
197197

@@ -201,14 +201,14 @@ For an example, refer to [MyCustomControl.cs](https://github.com/NuGet/Samples/b
201201

202202
## Package content such as images
203203

204-
To package content such as images that can be used by your control or the consuming UWP project. add those files `lib\uap10.0.14393.0` folder as follows:
204+
To package content such as images that can be used by your control or the consuming UWP project. add those files `lib\uap10.0.14393.0` folder as follows ("your_assembly_name" should again match your particular control):
205205

206206
```
207207
\build
208208
\lib
209209
\uap10.0.14393.0
210210
\Design
211-
\ManagedPackage
211+
\your_assembly_name
212212
\contosoSampleImage.jpg
213213
\tools
214214
```

0 commit comments

Comments
 (0)