SyntaxTree.FilePath Property

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

SyntaxTree.cs

The path of the source document file.

public:
 abstract property System::String ^ FilePath { System::String ^ get(); };

public abstract string FilePath { get; }

member this.FilePath : string

Public MustOverride ReadOnly Property FilePath As String

Property Value

String

Remarks

If this syntax tree is not associated with a file, this value can be empty. The path shall not be null.

The file doesn't need to exist on disk. The path is opaque to the compiler. The only requirement on the path format is that the implementations of SourceReferenceResolver, XmlReferenceResolver and MetadataReferenceResolver passed to the compilation that contains the tree understand it.

Clients must also not assume that the values of this property are unique within a Compilation.

The path is used as follows: - When debug information is emitted, this path is embedded in the debug information. - When resolving and normalizing relative paths in #r, #load, #line/#ExternalSource, #pragma checksum, #ExternalChecksum directives, XML doc comment include elements, etc.