Documents.Item 方法
返回 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 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。