IPersistentSpan.TryGetSpan(Span) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text

Assembly:: Microsoft.VisualStudio.Text.Data.dll

Package:: Microsoft.VisualStudio.Text.Data v17.11.260

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get the span as a character offset from the start of the buffer.

public:
 bool TryGetSpan([Runtime::InteropServices::Out] Microsoft::VisualStudio::Text::Span % span);

public:
 bool TryGetSpan([Runtime::InteropServices::Out] Microsoft::VisualStudio::Text::Span &  span);

bool TryGetSpan([Runtime::InteropServices::Out] Microsoft::VisualStudio::Text::Span & span);

public bool TryGetSpan (out Microsoft.VisualStudio.Text.Span span);

abstract member TryGetSpan : Span -> bool

Public Function TryGetSpan (ByRef span As Span) As Boolean

Parameters

span: Span

Corresponding span in the buffer.

Returns

Boolean

true if the the out parameters are valid; false otherwise (in which case TryGetStartLineIndex/TryGetEndLineIndex will work).

Remarks

This method can be used on any span if the underlying document is open.

If the underlying document is closed, then this method only be used if the document was created using the span method of the factory and the document has never been opened after the span was created.

In general, you should try to use TryGetStartLineIndex(Int32, Int32) and TryGetEndLineIndex(Int32, Int32) before using this method.

Applies to

Share via