SyntaxTree.GetMappedLineSpan(TextSpan, CancellationToken) Method

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.7.0

Source:

SyntaxTree.cs

Gets the location in terms of path, line and column after applying source line mapping directives (#line in C# or #ExternalSource in VB).

public abstract Microsoft.CodeAnalysis.FileLinePositionSpan GetMappedLineSpan (Microsoft.CodeAnalysis.Text.TextSpan span, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMappedLineSpan : Microsoft.CodeAnalysis.Text.TextSpan * System.Threading.CancellationToken -> Microsoft.CodeAnalysis.FileLinePositionSpan

Public MustOverride Function GetMappedLineSpan (span As TextSpan, Optional cancellationToken As CancellationToken = Nothing) As FileLinePositionSpan

Parameters

span

TextSpan

Span within the tree.

cancellationToken

CancellationToken

Cancellation token.

Returns

FileLinePositionSpan

A valid FileLinePositionSpan that contains path, line and column information.

If the location path is mapped the resulting path is the path specified in the corresponding #line, otherwise it's FilePath.

A location path is considered mapped if it is preceded by a line mapping directive that either specifies an explicit file path or is #line default.