Método Documents.Item

Artigo
10/26/2012

Retorna um membro indexado de um Documents coleção.

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

Sintaxe

'Declaração
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

Parâmetros

index
Tipo: System.Object
Obrigatório.O índice do item para retornar.

Valor de retorno

Tipo: EnvDTE.Document
A Document object.

Comentários

Para a maioria dos objetos, o valor passado para Index é um número inteiro que é um índice para um objeto em sua coleção.Para muitos objetos, no entanto, o valor de Index também pode ser um valor string que é igual a um objeto da coleção.O valor exato que é aceita pelo Item, porém, varia de acordo com a coleta e a sua implementação.

O Item método lança um ArgumentException exceção se a coleção não é possível localizar o objeto que corresponde ao valor de índice.

Exemplos

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

Documents Interface

Namespace EnvDTE

Outros recursos

Como: compilar e executar os exemplos de código de modelo de objeto de automação

Partilhar via