Document Class

The path to the document file or null if there is no document file.

The sequence of logical folders the document is contained in.

The document's identifier. Many document instances may share the same ID, but only one document in a solution may have that ID.

The name of the document.

The project this document belongs to.

The kind of source code this document contains.

if this Document supports providing data through the GetSemanticModelAsync(CancellationToken) method. If then this method will return instead.

if this Document supports providing data through the GetSyntaxTreeAsync(CancellationToken) and GetSyntaxRootAsync(CancellationToken) methods. If then these methods will return instead.

Gets the list of DocumentIds that are linked to this Document. Documents are considered to be linked if they share the same FilePath. This DocumentId is excluded from the result.

Gets the current semantic model for this document if the model is already computed and still cached. In almost all cases, you should call GetSemanticModelAsync(CancellationToken), which will compute the semantic model if necessary.

Gets the root node of the current syntax tree if the syntax tree has already been parsed and the tree is still cached. In almost all cases, you should call GetSyntaxRootAsync(CancellationToken) to fetch the root node, which will parse the document if necessary.

Get the current syntax tree for the document if the text is already loaded and the tree is already parsed. In almost all cases, you should call GetSyntaxTreeAsync(CancellationToken) to fetch the tree, which will parse the tree if it's not already parsed.

Get the current syntax tree version for the document if the text is already loaded and the tree is already parsed. In almost all cases, you should call GetSyntaxVersionAsync(CancellationToken) to fetch the version, which will load the tree if it's not already available.

Get the current text for the document if it is already loaded and available.

Gets the version of the document's text if it is already loaded and available.

Creates a new instance of this document updated to have the specified file path.

Creates a new instance of this document updated to have the specified name.

Creates a new instance of this document updated to have the source code kind specified.

Creates a new instance of this document updated to have a syntax tree rooted by the specified syntax node.

Creates a new instance of this document updated to have the text specified.