TextPane.IsVisible(TextPoint, 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.

Returns a value indicating whether the character or specified characters are visible in the text pane.

bool IsVisible(EnvDTE::TextPoint const & Point, winrt::Windows::Foundation::IInspectable const & PointOrCount);

[System.Runtime.InteropServices.DispId(10)]
public bool IsVisible (EnvDTE.TextPoint Point, object PointOrCount);

[<System.Runtime.InteropServices.DispId(10)>]
abstract member IsVisible : EnvDTE.TextPoint * obj -> bool

Public Function IsVisible (Point As TextPoint, Optional PointOrCount As Object) As Boolean

Parameters

Point: TextPoint

Required. A TextPoint location used to determine if a character is visible. Since a Point is situated between two characters, the default interpretation (that is, when no value is given for the PointOrCount argument) is the first character immediately to the right of the text point. If the character after the text point is visible, then the Point is visible as well.

PointOrCount: Object

Optional. Another point that works with the first Point argument to indicate a range of text. IsVisible(TextPoint, Object) determines whether or not this range of text is visible. PointOrCount can also be set to a number of characters that follow Point to indicate the range of text.

If a value is not supplied to the PointOrCount argument, IsVisible(TextPoint, Object) checks for the visibility of the character immediately to the right of Point, because PointOrCount has a default value of 1.

Returns

Boolean

true if the point is visible; otherwise, false.

Attributes: DispIdAttribute

Examples

Sub IsVisibleExample(ByVal dte As EnvDTE.DTE)  
    Dim objTextDoc As TextDocument  
    Dim objTextPt As TextPoint  
    Dim objEP As EditPoint  
    Dim objTextPn As TextPane  

    ' Create a new text document.  
    dte.ItemOperations.NewFile("General\Text File")  

    ' Get a handle to the new document and create EditPoint,  
    ' TextPoint, and TextPane objects.  
    objTextDoc = dte.ActiveDocument.Object("TextDocument")  
    objEP = objTextDoc.StartPoint.CreateEditPoint  
    objTextPt = objTextDoc.StartPoint  
    objTextPn = dte.ActiveWindow.Object.ActivePane  

    ' Plug in some text.  
    objEP.Insert("A test sentence.")  

    ' Check the first ten characters for visibility.  
    If objTextPn.IsVisible(objTextPt, 10) = True Then  
        MsgBox("Text is visible")  
    Else  
        MsgBox("Text is not visible.")  
    End If  
End Sub

public void IsVisibleExample(_DTE dte)  
{  
    TextDocument td;  
    TextPoint tpt;  
    TextPane tpn;  
    EditPoint ep;  
    TextWindow tw;  
    // Create a new text document.  
    dte.ItemOperations.NewFile (@"General\Text   
    File","test.txt",Constants.vsViewKindTextView);  

    // Get a handle to the new document and create EditPoint,  
    // TextPoint, and TextPane objects.  
    td = (TextDocument)dte.ActiveDocument.Object ("TextDocument");  
    ep = td.StartPoint.CreateEditPoint();  
    tpt = td.StartPoint;  
    tw = (TextWindow)dte.ActiveWindow.Object;  
    tpn = tw.ActivePane;  

    // Plug in some text.  
    ep.Insert ("A test sentence.");  

    // Check the first ten characters for visibility.  
    if (tpn.IsVisible (tpt,10))  
        MessageBox.Show ("Text is visible");  
    else  
        MessageBox.Show ("Text is not visible.");  
}

Remarks

If a value is supplied to PointOrCount, then IsVisible returns true when the entire selected range of text is visible.

Applies to