Metodo Documents.Item

Restituisce un membro indicizzato di un oggetto Documents raccolta.

Spazio dei nomi:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Sintassi

'Dichiarazione
Function Item ( _
    index As Object _
) As Document
Document Item(
    Object index
)
Document^ Item(
    [InAttribute] Object^ index
)
abstract Item : 
        index:Object -> Document 
function Item(
    index : Object
) : Document

Parametri

  • index
    Tipo: System.Object
    obbligatorio.Indice dell'elemento da restituire.

Valore restituito

Tipo: EnvDTE.Document
In Document oggetto.

Note

Per la maggior parte degli oggetti, il valore viene passato a Index è un Integer che è un indice a un oggetto nella raccolta.Per molti oggetti, tuttavia, il valore di Index può anche essere un valore stringa che corrisponde a un oggetto nella raccolta.Il valore esatto che viene accettato da Item, tuttavia, è possibile dipendere dalla raccolta e dall'implementazione.

Item il metodo genera un'eccezione ArgumentException eccezione se la raccolta impossibile trovare l'oggetto che corrisponde al valore di indice.

Esempi

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

Sicurezza di .NET Framework

Vedere anche

Riferimenti

Documents Interfaccia

Spazio dei nomi EnvDTE

Altre risorse

Procedura: compilare ed eseguire gli esempi di codice del modello a oggetti di automazione