EditPoint.TryToShow(vsPaneShowHow, Object) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Attempts to display the text point's location.

bool TryToShow(EnvDTE::vsPaneShowHow How = EnvDTE.vsPaneShowHow.vsPaneShowCentered, winrt::Windows::Foundation::IInspectable const & PointOrCount);

[System.Runtime.InteropServices.DispId(50)]
public bool TryToShow (EnvDTE.vsPaneShowHow How = EnvDTE.vsPaneShowHow.vsPaneShowCentered, object PointOrCount);

[<System.Runtime.InteropServices.DispId(50)>]
abstract member TryToShow : EnvDTE.vsPaneShowHow * obj -> bool

Public Function TryToShow (Optional How As vsPaneShowHow = EnvDTE.vsPaneShowHow.vsPaneShowCentered, Optional PointOrCount As Object) As Boolean

Parameters

How: vsPaneShowHow

Optional. A vsPaneShowHow constant that determines how the code is displayed.

PointOrCount: Object

Optional. The endpoint of the selected range of text to be displayed. It can be either a TextPoint or an integer.

Returns

Boolean

true if the span of text fits within the current code editor; otherwise, false.

Implements

TryToShow(vsPaneShowHow, Object)

Attributes: DispIdAttribute

Examples

Sub TryToShowExample(ByVal dte As DTE2)  

    ' Before running this example, open a text document.  
    Dim win As Window = dte.ActiveWindow  
    Dim textWin As TextWindow = CType(win.Object, TextWindow)  

    ' Split the text document window.  
    Dim cmd As Command = dte.Commands.Item("Window.Split")  
    dte.Commands.Raise(cmd.Guid, cmd.ID, Nothing, Nothing)  

    ' Display the beginning of the document in the top pane and the   
    ' end of the document in the bottom pane.  
    Dim sel As TextSelection = textWin.Panes.Item(2).Selection  
    sel.StartOfDocument()  
    sel.ActivePoint.TryToShow()  
    sel = textWin.Panes.Item(1).Selection  
    sel.EndOfDocument()  
    sel.ActivePoint.TryToShow()  

End Sub

public void TryToShowExample(DTE2 dte)  
{  
    // Before running this example, open a text document.  
    Window win = dte.ActiveWindow;  
    TextWindow textWin = (TextWindow)win.Object;  

    // Split the text document window.  
    Command cmd = dte.Commands.Item("Window.Split", -1);  
    object dummy = null;  
    dte.Commands.Raise(cmd.Guid, cmd.ID, ref dummy, ref dummy);  

    // Display the beginning of the document in the top pane and the   
    // end of the document in the bottom pane.  
    TextSelection sel = textWin.Panes.Item(2).Selection;  
    sel.StartOfDocument(false);  
    sel.ActivePoint.TryToShow(vsPaneShowHow.vsPaneShowCentered, null);  
    sel = textWin.Panes.Item(1).Selection;  
    sel.EndOfDocument(false);  
    sel.ActivePoint.TryToShow(vsPaneShowHow.vsPaneShowCentered, null);  
}

Remarks

TryToShow adjusts the location of the buffer in the code view so that the indicated range of text is displayed in the code editor, if possible. TryToShow is similar to the TextPane object's Activate method except that it attempts to display the window and the specified range of text.

Applies to