Documents.Item - метод

Статья
11/01/2012

Возвращает индексированный член коллекции Documents.

Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)

Синтаксис

'Декларация
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

Параметры

index
Тип: System.Object
Обязательный.Индекс возвращаемого элемента.

Возвращаемое значение

Тип: EnvDTE.Document
Объект Document.

Заметки

Для большинства объектов, значение, переданное в параметр Index представляет собой целочисленный индекс объекта в его коллекции.Для многих объектов значение Index также может быть строкой, которая указывает на объект в коллекции.Точное значение, которое принимает Item, зависит от коллекции и ее реализации.

Если коллекция не может найти объект, который соответствует значению индекса, метод Item вызывает исключение ArgumentException.

Примеры

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

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

Documents Интерфейс

EnvDTE - пространство имен

Другие ресурсы

Практическое руководство. Компиляция и выполнение примеров кода модели объектов автоматизации

Поделиться через