TextPane2.TryToShow - метод (TextPoint, vsPaneShowHow, Object)

Статья
08/11/2011

Корректирует положение представления в текстовом буфере таким образом, чтобы указанный фрагмент текста отображался в текстовой области (если возможно). Местом отображения текста в области можно управлять.

Пространство имен: EnvDTE80
Сборка: EnvDTE80 (в EnvDTE80.dll)

Синтаксис

'Декларация
Function TryToShow ( _
    Point As TextPoint, _
    How As vsPaneShowHow, _
    PointOrCount As Object _
) As Boolean

bool TryToShow(
    TextPoint Point,
    vsPaneShowHow How,
    Object PointOrCount
)

bool TryToShow(
    [InAttribute] TextPoint^ Point, 
    [InAttribute] vsPaneShowHow How, 
    [InAttribute] Object^ PointOrCount
)

abstract TryToShow : 
        Point:TextPoint * 
        How:vsPaneShowHow * 
        PointOrCount:Object -> bool

function TryToShow(
    Point : TextPoint, 
    How : vsPaneShowHow, 
    PointOrCount : Object
) : boolean

Параметры

Point
Тип: EnvDTE.TextPoint
Обязательный.Место TextPoint, в котором нужно показать фрагмент текста.

How
Тип: EnvDTE.vsPaneShowHow
Обязательный.Константа vsPaneShowHow, показывающая способ отображения текста.

PointOrCount
Тип: System.Object
Необязательный.Значение типа variant, представляющее конец отображаемого фрагмента текста.Если параметр PointOrCount задает число символов, то символы следуют за Point.Если параметр PointOrCount — это точка перед Point, тогда текст находится в верхней части текстовой области, если параметр How имеет значение vsPaneShowTop.
Если параметр How имеет значение vsPaneShowCentered и число строк в выделенном фрагменте текста больше, чем высота текстовой области, то верхняя строка выделенного фрагмента текста помещается в верхней части текстовой области.

Возвращаемое значение

Тип: System.Boolean
Значение true, если текст можно отобразить; в противном случае — false.

Реализации

TextPane.TryToShow(TextPoint, vsPaneShowHow, Object)

Примеры

В этом примере открывается текстовый документ, отображается текст из него и потом с помощью метода TryToShow объекта TextPane2 показывается окно, содержащее текстовую область. Дополнительные сведения о запуске этого примера в виде надстройки см. в разделе Практическое руководство. Компиляция и выполнение примеров кода модели объектов автоматизации.

Imports EnvDTE
Imports EnvDTE80
Public Sub OnConnection(ByVal application As Object, _
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    TextPane2TryToShowExample(_applicationObject)
End Sub
Sub TextPane2TryToShowExample(ByVal dte As DTE2)
    Dim objTW As TextWindow
    Dim objPane As TextPane2
    Dim objTextDoc As TextDocument
    Dim objTextPt As TextPoint
    Dim objEP As EditPoint
    Dim objStart As TextPoint
    ' Create a new text document.
    _applicationObject.ItemOperations.NewFile("General\Text File")
    ' Get a handle to the new document and create EditPoint,
    ' TextPoint, and TextPane objects.
    objTextDoc = CType(_applicationObject.ActiveDocument.Object _
     ("TextDocument"), TextDocument)
    objEP = objTextDoc.StartPoint.CreateEditPoint
    objTextPt = objTextDoc.StartPoint
    ' Plug in some text.
    objEP.Insert("A test sentence.")
    objTW = CType(dte.ActiveWindow.Object, TextWindow)
    objPane = CType(objTW.ActivePane, TextPane2)
    MsgBox("The active pane is " & Str(objPane.Height)  _
    & " lines high and " & Str(objPane.Width) & " columns wide.")
    objStart = objPane.StartPoint
    MsgBox("It begins at line " & Str(objStart.Line)  _
    & ", column " & Str(objStart.LineCharOffset) & ".")
    MsgBox("Using TryToShow to center the pane...")
    objPane.TryToShow(objStart, vsPaneShowHow.vsPaneShowCentered)
End Sub

using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
public void OnConnection(object application, 
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    TextPane2TryToShowExample(_applicationObject);
}
public void TextPane2TryToShowExample(DTE2 dte)
{
    TextWindow objTW;
    TextPane2 objPane;
    TextDocument objTextDoc;
    TextPoint objTextPt;
    EditPoint2 objEP;
    TextPoint objStart;
    // Create a new text document.
    _applicationObject.ItemOperations.NewFile
(@"General\Text File", "test.txt", Constants.vsViewKindTextView);
    // Get a handle to the text document and create EditPoint2,
    // TextPoint, and TextPane2 objects.
    objTextDoc =(TextDocument)_applicationObject.ActiveDocument.Object
("TextDocument");
    objEP = (EditPoint2)objTextDoc.StartPoint.CreateEditPoint();
    objTextPt = objTextDoc.StartPoint;
    // Plug in some text.
    objEP.Insert("A test sentence.");
    objTW = (TextWindow)_applicationObject.ActiveWindow.Object;
    objPane = (TextPane2)objTW.ActivePane;
    MessageBox.Show("The active pane is " + objPane.Height 
+ " lines high and " + objPane.Width + " columns wide.");
    objStart = objPane.StartPoint;
    MessageBox.Show("It begins at line " + objStart.Line 
+ ", column " + objStart.LineCharOffset + ".");
    MessageBox.Show("Using TryToShow to show the pane as centered...");
    objPane.TryToShow(objStart, vsPaneShowHow.vsPaneShowCentered, 2);
}

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

TextPane2 Интерфейс

TryToShow - перегрузка

EnvDTE80 - пространство имен

Поделиться через