AdditionalDocument Class

Definition

Represents an additional file passed down to analyzers.

public sealed class AdditionalDocument : Microsoft.CodeAnalysis.TextDocument
type AdditionalDocument = class
    inherit TextDocument
Public NotInheritable Class AdditionalDocument
Inherits TextDocument
Inheritance
AdditionalDocument

Properties

FilePath

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

(Inherited from TextDocument)
Folders

The sequence of logical folders the document is contained in.

(Inherited from TextDocument)
Id

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

(Inherited from TextDocument)
Name

The name of the document.

(Inherited from TextDocument)
Project

The project this document belongs to.

(Inherited from TextDocument)

Methods

GetTextAsync(CancellationToken)

Gets the current text for the document asynchronously.

(Inherited from TextDocument)
GetTextVersionAsync(CancellationToken)

Gets the version of the document's text.

(Inherited from TextDocument)
TryGetText(SourceText)

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

(Inherited from TextDocument)
TryGetTextVersion(VersionStamp)

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

(Inherited from TextDocument)

Applies to