VCFile::RelativePath Property

Visual Studio 2015
 

Gets or sets the relative path to the file. This path must be relative to the project directory and can contain macros.

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

C#
C++
F#
VB
Copy 
property String^ RelativePath {
	String^ get();
	void set(String^ value);
}

Property Value

Type: System::String^

The relative path to the file.

Any attempt to set the relative path of a file must result in a path that agrees with the FullPath property. See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

The following example uses the RelativePath property in the integrated development environment (IDE):

VB
Copy 
' add reference to Microsoft.VisualStudio.VCProjectEngine
Imports EnvDTE
Imports Microsoft.VisualStudio.VCProjectEngine

Public Module Module1
    Sub Test()
        Dim file As VCFile
        Dim col As IVCCollection
        Dim idx As Integer
        Dim prj As VCProject
        prj = DTE.Solution.Projects.Item(1).Object
        col = prj.Files
        For idx = 1 To col.Count
            file = col.Item(idx)
            MsgBox(file.RelativePath)
        Next
    End Sub
End Module
Return to top
Show: