VCFile.RelativePath Property

Definition

Namespace:

Microsoft.VisualStudio.VCProjectEngine

Assembly:

Microsoft.VisualStudio.VCProjectEngine.dll

Package:

Microsoft.VisualStudio.VCProjectEngine v17.12.40390

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

public:
 property System::String ^ RelativePath { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ RelativePath { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(402)]
public string RelativePath { [System.Runtime.InteropServices.DispId(402)] get; [System.Runtime.InteropServices.DispId(402)] set; }

[<System.Runtime.InteropServices.DispId(402)>]
[<get: System.Runtime.InteropServices.DispId(402)>]
[<set: System.Runtime.InteropServices.DispId(402)>]
member this.RelativePath : string with get, set

Public Property RelativePath As String

Property Value

String

The relative path to the file.

Attributes

DispIdAttribute

Examples

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

' 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  

Remarks

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.