TextPane.IsVisible メソッド

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

文字または指定した文字列がテキストペインに表示されているかどうかを示す値を返します。

名前空間 : EnvDTE
アセンブリ : EnvDTE (EnvDTE.dll 内)

構文

'宣言
Function IsVisible ( _
    Point As TextPoint, _
    PointOrCount As Object _
) As Boolean
'使用
Dim instance As TextPane
Dim Point As TextPoint
Dim PointOrCount As Object
Dim returnValue As Boolean

returnValue = instance.IsVisible(Point, _
    PointOrCount)

bool IsVisible(
    TextPoint Point,
    Object PointOrCount
)

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

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

パラメータ

Point
型 : EnvDTE.TextPoint

必ず指定します。文字が表示されているかどうかを判断するために使用する TextPoint の位置。Point は 2 つの文字の間に位置するため、既定 (引数 PointOrCount に値が指定されていない場合) では、テキストポイントのすぐ右側にある最初の文字と解釈されます。テキストポイントの後の文字が表示されている場合は、Point も表示されています。

PointOrCount
型 : System.Object

省略可能です。テキスト範囲を示す最初の引数 Point を使用する別のポイントを指定します。IsVisible は、このテキスト範囲が表示されているかどうかを判断します。また、PointOrCount に、Point の後に続く文字数を設定してテキスト範囲を示すこともできます。

引数 PointOrCount に値が指定されていない場合、PointOrCount の既定値は 1 であるため、IsVisible は、Point のすぐ右側にある文字が表示されているかどうかをチェックします。

戻り値

型 : System.Boolean

ポイントが表示されている場合は true。それ以外の場合は false。

解説

PointOrCount に値が指定されている場合に、テキストの選択範囲全体が表示されていると、IsVisible は true を返します。

例

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