Documents.Item (Método)

Devuelve un miembro indizado de una colección Documents.

Espacio de nombres:  EnvDTE
Ensamblado:  EnvDTE (en EnvDTE.dll)

Sintaxis

'Declaración
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
  Obligatorio.Índice del elemento que se devolverá.

Valor devuelto

Tipo: EnvDTE.Document
Un objeto Document.

Comentarios

Para la mayoría de los objetos, el valor pasado a Index es un entero que es un índice de un objeto de su colección.Para muchos objetos, sin embargo, el valor de Index también puede ser un valor de cadena que equivale a un objeto de la colección.El valor exacto aceptado por Item, aunque dependerá de la colección y su implementación.

El método Item produce una excepción ArgumentException si la colección no puede encontrar el objeto que corresponde al valor de índice.

Ejemplos

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

Seguridad de .NET Framework

• Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.

Vea también

Referencia

Documents Interfaz

EnvDTE (Espacio de nombres)

Otros recursos

Cómo: Compilar y ejecutar los ejemplos de código del modelo de objetos de automatización