Documents.Item メソッド

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

更新 : 2007 年 11 月

Documents コレクションのインデックス付きメンバを返します。

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

構文

'宣言
Function Item ( _
    index As Object _
) As Document
'使用
Dim instance As Documents
Dim index As Object
Dim returnValue As Document

returnValue = instance(index)

Document Item(
    Object index
)

Document^ Item(
    [InAttribute] Object^ index
)

function Item(
    index : Object
) : Document

パラメータ

index
型 : System.Object

必ず指定します。返すアイテムのインデックス。

戻り値

型 : EnvDTE.Document

Document オブジェクト。

解説

ほとんどのオブジェクトでは、Index に渡される値はコレクション内のオブジェクトへのインデックスである整数です。ただし、多くのオブジェクトは、Index の値としてコレクション内のオブジェクトを表す文字列値を指定できます。ただし、Item が受け入れる正確な値は、コレクションとその実装によって異なります。

Item メソッドは、コレクションがインデックス値に対応するオブジェクトを見つけられない場合に ArgumentException 例外をスローします。

例

Sub ItemExample(ByVal dte As DTE2)

    ' NOTE: This example requires a reference to the 
    '       System.Collections namespace.

    If MsgBox("Close all saved documents?", MsgBoxStyle.YesNo) = _
        MsgBoxResult.Yes Then
        ' Create a list of all saved documents.
        Dim docs As Documents = dte.Documents
        Dim savedDocs As New ArrayList

        Dim i As Integer
        For i = 1 To docs.Count
            If docs.Item(i).Saved Then
                savedDocs.Add(docs.Item(i))
            End If
        Next

        ' Close all saved documents.
        Dim doc As Document
        For Each doc In savedDocs
            doc.Close(vsSaveChanges.vsSaveChangesNo)
        Next
    End If

End Sub

public void ItemExample(DTE2 dte)
{
    // NOTE: This example requires a reference to the 
    //       System.Collections namespace.

    if (MessageBox.Show("Close all saved documents?", "", 
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        // Create a list of all saved documents.
        Documents docs = dte.Documents;
        ArrayList savedDocs = new ArrayList(); 

        for (int i = 1; i <= docs.Count; i++)
        {
            if (docs.Item(i).Saved)
                savedDocs.Add(docs.Item(i));
        }

        // Close all saved documents.
        foreach (Document doc in savedDocs)
            doc.Close(vsSaveChanges.vsSaveChangesNo);
    }
}