Documents.Item-Methode

Gibt einen indizierten Member einer Documents-Auflistung zurück.

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

Syntax

'Declaration
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

Parameter

• index
  Typ: Object

  Erforderlich. Der Index des zurückzugebenden Elements.

Rückgabewert

Typ: EnvDTE.Document
Ein Document-Objekt.

Hinweise

Für die meisten Objekte ist der an Index übergebene Wert eine ganze Zahl, die ein Index für ein Objekt in dessen Auflistung darstellt. Bei vielen Objekten kann es sich bei dem Wert von Index aber auch um einen Zeichenfolgewert handeln, der einem Objekt in der Auflistung entspricht. Der genaue von Item akzeptierte Wert hängt jedoch von der Auflistung und deren Implementierung ab.

Die Item-Methode löst eine ArgumentException-Ausnahme aus, wenn die Auflistung das dem Indexwert entsprechende Objekt nicht finden kann.

Beispiele

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

.NET Framework-Sicherheit

• Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

Documents Schnittstelle

EnvDTE-Namespace

Weitere Ressourcen

Gewusst wie: Kompilieren und Ausführen der Codebeispiele für das Automatisierungsobjektmodell