Documents.Item(Object) Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Returns an indexed member of a Documents collection.

public:
 EnvDTE::Document ^ Item(System::Object ^ index);

public:
 EnvDTE::Document ^ Item(Platform::Object ^ index);

EnvDTE::Document Item(winrt::Windows::Foundation::IInspectable const & index);

[System.Runtime.InteropServices.DispId(0)]
public EnvDTE.Document Item (object index);

[<System.Runtime.InteropServices.DispId(0)>]
abstract member Item : obj -> EnvDTE.Document

Public Function Item (index As Object) As Document

Parameters

index

Object

Required. The index of the item to return.

Returns

Document

A Document object.

Attributes

DispIdAttribute

Examples

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

Remarks

For most objects, the value passed to Index is an integer that is an index to an object in its collection. For many objects, though, the value of Index can also be a string value that equates to an object in the collection. The exact value that is accepted by Item, though, depends on the collection and its implementation.

The Item method throws a ArgumentException exception if the collection cannot find the object that corresponds to the index value.