EditPoint.TryToShow Method (vsPaneShowHow, Object)


Attempts to display the text point's location.

Namespace:   EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

bool TryToShow(
	vsPaneShowHow How = vsPaneShowHow.vsPaneShowCentered,
	object PointOrCount


Type: EnvDTE.vsPaneShowHow

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

Type: System.Object

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

Return Value

Type: System.Boolean

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

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.

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.ActivePoint.TryToShow(vsPaneShowHow.vsPaneShowCentered, null);
    sel = textWin.Panes.Item(1).Selection;
    sel.ActivePoint.TryToShow(vsPaneShowHow.vsPaneShowCentered, null);
Return to top