Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
WebReferencesFolder Property
Collapse the table of content
Expand the table of content

WebReferencesFolder Property

Visual Studio .NET 2003

Returns the ProjectItem object representing the Web References folder of the project. If the folder does not exist, this property returns Nothing (a null reference). Read-only.

[Visual Basic .NET]
Public ReadOnly Property WebReferencesFolder() As ProjectItem
[Visual Basic 6]
Property Get WebReferencesFolder() As ProjectItem
[C++]
HRESULT __stdcall get_WebReferencesFolder(
   /* [out, retval] */ ProjectItem** retVal
);
[C#]
ProjectItem WebReferencesFolder {get;}
[JScript .NET]
public function get WebReferencesFolder() : ProjectItem

Return Value

Returns a ProjectItem Object.

Remarks

A project's Web references may be retrieved by accessing the ProjectItems property of the WebReferencesFolder property.

A project contains at most one Web References folder. The folder may be created using the CreateWebReferencesFolder method. In addition, the folder is created automatically when the first Web reference is added to the project using the AddWebReference method.

In a Visual Basic or C# project, the Kind property of the WebReferencesFolder project item is always EnvDTE.Constants.vsProjectItemKindPhysicalFolder, since Visual Basic and C# projects only support physical files.

Example

' Macro Editor
' This example creates a Web references folder, if it does not 
' already exist, and displays some of the folder properties.
Imports VSLangProj
Sub WebReferencesFolderExample()
   ' This example assumes that the first project in the 
   ' solution is either a Visual Basic or C# project.
   Dim aVSProject As VSProject = _
      CType(DTE.Solution.Projects.Item(1).Object, VSProject)
        
   ' Add a new folder if it does not already exist.
   If (aVSProject.WebReferencesFolder Is Nothing) Then
      Dim newFolder As ProjectItem
      newFolder = aVSProject.CreateWebReferencesFolder()
   End If
        
   ' Display the name of the Web references folder.
   Dim theFolder As ProjectItem = aVSProject.WebReferencesFolder
   MsgBox("The name of the WebReferences folder is " _
      & theFolder.Name & ".")
        
   ' All Visual Basic and C# Web references folders are physical.
   If (theFolder.Kind = _
      EnvDTE.Constants.vsProjectItemKindPhysicalFolder) Then
      MsgBox(theFolder.Name & " is a physical folder.")
   End If

   MsgBox("There are " & theFolder.ProjectItems.Count.ToString() & _
      " Web references.")
End Sub

See Also

AddWebReference Method (VSProject Object) | CreateWebReferencesFolder Method

Applies To: VSProject Object

Show:
© 2015 Microsoft