IViewScroller.EnsureSpanVisible Method (VirtualSnapshotSpan, EnsureSpanVisibleOptions)

Ensures that all the text in the specified span is entirely visible in the view.

Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)

Syntax

'Declaration
Sub EnsureSpanVisible ( _
    span As VirtualSnapshotSpan, _
    options As EnsureSpanVisibleOptions _
)

void EnsureSpanVisible(
    VirtualSnapshotSpan span,
    EnsureSpanVisibleOptions options
)

void EnsureSpanVisible(
    VirtualSnapshotSpan span, 
    EnsureSpanVisibleOptions options
)

abstract EnsureSpanVisible : 
        span:VirtualSnapshotSpan * 
        options:EnsureSpanVisibleOptions -> unit

function EnsureSpanVisible(
    span : VirtualSnapshotSpan, 
    options : EnsureSpanVisibleOptions
)

Parameters

• span
  Type: Microsoft.VisualStudio.Text.VirtualSnapshotSpan

  The span to make visible.

• options
  Type: Microsoft.VisualStudio.Text.Editor.EnsureSpanVisibleOptions

  The EnsureSpanVisibleOptions.

Remarks

The view will not be scrolled if the text in span is completely visible. If the text in span is partially visible, then the view will be scrolled as little as possible to make the text completely visible. If none of the text in span was visible, then it will be centered in the view.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IViewScroller Interface

EnsureSpanVisible Overload

Microsoft.VisualStudio.Text.Editor Namespace