ITextStructureNavigator.GetSpanOfNextSibling(SnapshotSpan) Method

Definition

Gets the span of the next sibling syntactic element of the specified snapshot span. If the snapshot span has zero length, then the behavior is the same as that of GetSpanOfEnclosing(SnapshotSpan).

public:
 Microsoft::VisualStudio::Text::SnapshotSpan GetSpanOfNextSibling(Microsoft::VisualStudio::Text::SnapshotSpan activeSpan);
Microsoft::VisualStudio::Text::SnapshotSpan GetSpanOfNextSibling(Microsoft::VisualStudio::Text::SnapshotSpan activeSpan);
public Microsoft.VisualStudio.Text.SnapshotSpan GetSpanOfNextSibling (Microsoft.VisualStudio.Text.SnapshotSpan activeSpan);
abstract member GetSpanOfNextSibling : Microsoft.VisualStudio.Text.SnapshotSpan -> Microsoft.VisualStudio.Text.SnapshotSpan
Public Function GetSpanOfNextSibling (activeSpan As SnapshotSpan) As SnapshotSpan

Parameters

activeSpan
SnapshotSpan

The SnapshotSpan from which to get the span of the next sibling syntactic element.

Returns

SnapshotSpan

A SnapshotSpan that represents the next sibling syntactic element. If the given active span covers multiple syntactic elements, then this method returns the span of the next sibling element. If the specified snapshot span covers a syntactic element that does not have a sibling element, then the behavior is the same as that of GetSpanOfEnclosing(SnapshotSpan).

Remarks

If the snapshot span has zero length, then the behavior is the same as that of GetSpanOfEnclosing.

If the given active span covers multiple syntactic elements, then this method returns the span of the next sibling element.

If the specified snapshot span covers a syntactic element that does not have a sibling element, then the behavior is the same as that of GetSpanOfEnclosing.

Applies to