VCAssemblyReference Interface

Represents a reference to a .NET assembly.

Namespace: Microsoft.VisualStudio.VCProjectEngine
Assembly: Microsoft.VisualStudio.VCProjectEngine (in Microsoft.VisualStudio.VCProjectEngine.dll)

Syntax

'Declaration
<GuidAttribute("BBD5E771-EA8A-4665-817A-E79BA9AB77BD")> _
Public Interface VCAssemblyReference _
    Inherits VCReference
[GuidAttribute("BBD5E771-EA8A-4665-817A-E79BA9AB77BD")]
public interface VCAssemblyReference : VCReference
[GuidAttribute(L"BBD5E771-EA8A-4665-817A-E79BA9AB77BD")]
public interface class VCAssemblyReference : VCReference
[<GuidAttribute("BBD5E771-EA8A-4665-817A-E79BA9AB77BD")>]
type VCAssemblyReference =  
    interface 
        interface VCReference 
    end
public interface VCAssemblyReference extends VCReference

The VCAssemblyReference type exposes the following members.

Properties

Name Description
Public property AssemblyName Gets the name of the assembly. The assembly name is a short, friendly name for an assembly. The assembly name, assembly version, originator key, and locale are used by the common language runtime to uniquely identify an assembly during binding.
Public property BuildNumber Gets the build number of the referenced assembly.
Public property CopyLocal Gets or sets a value indicating whether to automatically copy the reference to the target directory.
Public property CopyLocalDependencies Gets or sets a value indicating whether to automatically copy the referenced assembly's non-system dependencies to the target location during a build.
Public property CopyLocalSatelliteAssemblies Gets or sets a value indicating whether to automatically copy the referenced assembly's satellite assemblies to the target location during a build.
Public property Culture Gets the culture for the selected reference.
Public property Description Gets or sets a string that represents the description for the object or the use of the output group.
Public property FullPath Gets the full path of the project file.
Public property Identity Gets the identity of the referenced assembly.
Public property ItemName Gets the name of the current item in the collection.
Public property Kind Gets an enumeration indicating the type of object.
Public property Label Gets the display name of the referenced assembly.
Public property majorVersion Gets the major version of the referenced assembly.
Public property MinFrameworkVersion Gets the minimum version of the .NET Framework required by the project.
Public property minorVersion Gets the minor version of the referenced assembly.
Public property Name Gets or sets the name of the object.
Public property Parent Gets the immediate parent object of a given object.
Public property project Gets the generic Project object associated with the Visual Basic or Visual C# project. This property is read-only.
Public property PublicKeyToken Gets the public key token for the referenced assembly.
Public property Reference Gets the associated reference.
Public property RelativePath Gets or sets the path to the selected reference, relative to the project directory.
Public property RevisionNumber Gets the revision number of the selected reference.
Public property StrongName Gets a value indicating whether or not the selected reference has a strong name.
Public property SubType Gets or sets the file's subtype as understood by the designers.
Public property UseDependenciesInBuild Gets or sets a value indicating whether this assembly's dependencies are used in the build process.
Public property UseInBuild Gets or sets a value indicating whether this assembly is used in the build process.
Public property VCProjectEngine Gets a pointer to the project engine.
Public property VCReferences Gets the collection of references for the selected project.
Public property Version Gets the version of the selected reference.

Top

Methods

Name Description
Public method MatchName Matches a specified name to the name of a collection item.
Public method Remove Removes the specified project from the solution.

Top

Remarks

See Working with Project Properties for information about accessing a project's property pages dialog box.

Examples

' Add a reference to Microsoft.VisualStudio.VCProjectEngine and have a 
' Visual C++ project loaded before running this example.
Imports EnvDTE
Imports Microsoft.VisualStudio.VCProjectEngine
Public Module Module1
    Sub Test()
        Dim prj As VCProject
        Dim vcar As VCAssemblyReference
        Dim refcfg As VCReferenceConfiguration

        prj = DTE.Solution.Projects.Item(1).Object
        If prj.CanAddAssemblyReference("C:\Program Files\ _
        Microsoft Visual Studio 8\Common7\IDE\ _
        PublicAssemblies\envdte.dll") Then
           vcar = prj.AddAssemblyReference("C:\Program Files\ _
           Microsoft Visual Studio 8\Common7\IDE\ _
           PublicAssemblies\envdte.dll")
        End If
        refcfg = vcar.ReferenceConfigurations.Item(1)
        MsgBox("Consumable? " & refcfg.ConsumableByDesigner)
    End Sub
End Module

See Also

Reference

Microsoft.VisualStudio.VCProjectEngine Namespace