Documents.Item, méthode

Article
08/10/2011

Retourne un membre indexé d'une collection Documents.

Espace de noms : EnvDTE
Assembly : EnvDTE (dans EnvDTE.dll)

Syntaxe

'Déclaration
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

Paramètres

index
Type : System.Object
Obligatoire.L'index de l'élément à retourner.

Valeur de retour

Type : EnvDTE.Document
Objet Document.

Notes

Pour la plupart des objets, la valeur passée à Index est un entier qui représente l'index d'un objet de sa collection. Néanmoins, pour de nombreux objets, la valeur d'Index peut également être une valeur de chaîne qui équivaut à un objet dans la collection. La valeur exacte acceptée par Item dépend cependant de la collection et de son implémentation.

La méthode Item lève une exception ArgumentException si la collection ne peut pas trouver l'objet correspondant à la valeur d'index.

Exemples

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

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

Documents Interface

EnvDTE, espace de noms

Autres ressources

Comment : compiler et exécuter les exemples de code du modèle objet Automation

Partager via