Document.Close(vsSaveChanges) Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Closes the open document and optionally saves it, or closes and destroys the window.

void Close(EnvDTE::vsSaveChanges Save = EnvDTE.vsSaveChanges.vsSaveChangesPrompt);

[System.Runtime.InteropServices.DispId(123)]
public void Close (EnvDTE.vsSaveChanges Save = EnvDTE.vsSaveChanges.vsSaveChangesPrompt);

[<System.Runtime.InteropServices.DispId(123)>]
abstract member Close : EnvDTE.vsSaveChanges -> unit

Public Sub Close (Optional Save As vsSaveChanges = EnvDTE.vsSaveChanges.vsSaveChangesPrompt)

Parameters

Save

vsSaveChanges

Optional. A vsSaveChanges constant that determines whether to save an item or items.

Attributes

DispIdAttribute

Examples

Sub CloseExample(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 CloseExample(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);  
        }  
    }  
}