Skip to content

fix: column name should be Item Metadata Name #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 2, 2018
Merged

fix: column name should be Item Metadata Name #413

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
756a51d
fix: column name should be Item Metadata Name
leonard-thieu Dec 31, 2017
51bdf30
fix: use canonical name for file reference
leonard-thieu Dec 31, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/msbuild/common-msbuild-project-items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ ms.workload:
- "multiple"
---
# Common MSBuild Project Items
In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)], an item is a named reference to one or more files. Items contain metadata such as file names, paths, and version numbers. All project types in [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)] have several items in common. These items are defined in the file microsoft.build.commontypes.xsd.
In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.md)], an item is a named reference to one or more files. Items contain metadata such as file names, paths, and version numbers. All project types in [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)] have several items in common. These items are defined in the file Microsoft.Build.CommonTypes.xsd.

## Common Items
The following is a list of all the common project items.

### Reference
Represents an assembly (managed) reference in the project.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|HintPath|Optional string. Relative or absolute path of the assembly.|
|Name|Optional string. The display name of the assembly, for example, "System.Windows.Forms."|
Expand All @@ -44,7 +44,7 @@ In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.m
### COMReference
Represents a COM (unmanaged) component reference in the project.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|Name|Optional string. The display name of the component.|
|Guid|Optional string. A GUID for the component, in the form {12345678-1234-1234-1234-1234567891234}.|
Expand All @@ -57,22 +57,22 @@ In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.m
### COMFileReference
Represents a list of type libraries that feed into the ResolvedComreference target.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|WrapperTool|Optional string. The name of the wrapper tool that is used on the component, for example, "tlbimp."|

### NativeReference
Represents a native manifest file or a reference to such a file.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|Name|Required string. The base name of the manifest file.|
|HintPath|Required string. The relative path of the manifest file.|

### ProjectReference
Represents a reference to another project.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|Name|Optional string. The display name of the reference.|
|Project|Optional string. A GUID for the reference, in the form {12345678-1234-1234-1234-1234567891234}.|
Expand All @@ -81,7 +81,7 @@ In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.m
### Compile
Represents the source files for the compiler.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|DependentUpon|Optional string. Specifies the file this file depends on to compile correctly.|
|AutoGen|Optional boolean. Indicates whether the file was generated for the project by the [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)] integrated development environment (IDE).|
Expand All @@ -92,7 +92,7 @@ In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.m
### EmbeddedResource
Represents resources to be embedded in the generated assembly.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|DependentUpon|Optional string. Specifies the file this file depends on to compile correctly|
|Generator|Required string. The name of any file generator that is run on this item.|
Expand All @@ -106,7 +106,7 @@ In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.m
### Content
Represents files that are not compiled into the project, but may be embedded or published together with it.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|DependentUpon|Optional string. Specifies the file this file depends on to compile correctly.|
|Generator|Required string. The name of any file generator that runs on this item.|
Expand All @@ -121,7 +121,7 @@ In [!INCLUDE[vstecmsbuild](../extensibility/internals/includes/vstecmsbuild_md.m
### None
Represents files that should have no role in the build process.

|Item Name|Description|
|Item Metadata Name|Description|
|---------------|-----------------|
|DependentUpon|Optional string. Specifies the file this file depends on to compile correctly.|
|Generator|Required string. The name of any file generator that is run on this item.|
Expand Down