Documents.Item – metoda

Článek
10/27/2012

Vrací indexovaný člen Documents kolekce.

Obor názvů: EnvDTE
Sestavení: EnvDTE (v EnvDTE.dll)

Syntaxe

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

Parametry

index
Typ: System.Object
Povinné.Index položky vrátit.

Vrácená hodnota

Typ: EnvDTE.Document
Objekt Document.

Poznámky

Většina objektů hodnoty předány Index indexu pro objekt v jeho kolekce je celé číslo.Pro mnoho objektů, ale hodnota Index může být také řetězcová hodnota, která se objekt v kolekci.Přesnou hodnotu, která přijaly Item, však závisí na shromažďování a jeho provádění.

Item Vyvolá metodu ArgumentException výjimku, pokud kolekce nemůže najít objekt, který odpovídá hodnotě indexu.

Příklady

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

Zabezpečení rozhraní .NET Framework

Plná důvěra přímému volajícímu. Částečně zabezpečený kód nemůže tento člen použít. Další informace naleznete v tématu Používání knihoven z částečně důvěryhodného kódu.

Viz také

Referenční dokumentace

Documents Rozhraní

EnvDTE – obor názvů

Další zdroje

Jak: kompilace a spuštění příkladů kódu automatizace objektu modelu

Sdílet prostřednictvím