Document.Close Method

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

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

Syntax

'Declaration
Sub Close ( _
    Save As vsSaveChanges _
)

void Close(
    vsSaveChanges Save
)

void Close(
    [InAttribute] vsSaveChanges Save
)

abstract Close : 
        Save:vsSaveChanges -> unit

function Close(
    Save : vsSaveChanges
)

Parameters

• Save
  Type: EnvDTE.vsSaveChanges

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

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Document Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples