TextPane.IsVisible Method

  • Article

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

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

Syntax

'Declaration
Function IsVisible ( _
    Point As TextPoint, _
    PointOrCount As Object _
) As Boolean

bool IsVisible(
    TextPoint Point,
    Object PointOrCount
)

bool IsVisible(
    [InAttribute] TextPoint^ Point, 
    [InAttribute] Object^ PointOrCount
)

abstract IsVisible : 
        Point:TextPoint * 
        PointOrCount:Object -> bool

function IsVisible(
    Point : TextPoint, 
    PointOrCount : Object
) : boolean

Parameters

  • Point
    Type: EnvDTE.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
    Type: System.Object

    Optional. Another point that works with the first Point argument to indicate a range of text. IsVisible 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 checks for the visibility of the character immediately to the right of Point, because PointOrCount has a default value of 1.

Return Value

Type: System.Boolean
true if the point is visible; otherwise, false.

Remarks

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

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.");
}

.NET Framework Security

See Also

Reference

TextPane Interface

EnvDTE Namespace