DocumentManager.CloseDocument(String) Method

Closes the specified document.

Namespace: DevExpress.Web.Office

Assembly: DevExpress.Web.v18.2.dll

Declaration

C#

public static void CloseDocument(
    string documentId
)

VB.NET

Public Shared Sub CloseDocument(
    documentId As String
)

Parameters

Name	Type	Description
documentId	String	A string value specifying the unique identifier of a document.

Remarks

C#

using DevExpress.Web.Office
...
protected void Page_Load(object sender, EventArgs e)
{
    if (!System.Web.UI.Page.IsPostBack)
    {
        RichEdit.Open(System.Web.UI.Page.Server.MapPath("~/App_Data/Styles.rtf"));
        RichEdit.DocumentId = "TestID";
    }
}
protected void RichEdit_Callback(object sender, DevExpress.Web.CallbackEventArgsBase e)
{
    DocumentManager.CloseDocument("TestID");
    RichEdit.Open(System.Web.UI.Page.Server.MapPath("~/App_Data/Styles.rtf"));
}

VB.NET

...
Imports DevExpress.Web.Office

  Partial Public Class _Default
    Inherits System.Web.UI.Page
     Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        If Not IsPostBack Then
            RichEdit.Open(Server.MapPath("~/App_Data/Styles.rtf"))
            RichEdit.DocumentId = "TestID"
        End If
    End Sub
    Protected Sub RichEdit_Callback(ByVal sender As Object, ByVal e As DevExpress.Web.CallbackEventArgsBase)
        DocumentManager.CloseDocument("TestID")
        RichEdit.Open(Server.MapPath("~/App_Data/Styles.rtf"))
    End Sub
End Class

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CloseDocument(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspxrichedit-how-to-save-and-load-documents-from-a-database-t352034/CS/ASPxRichEdit_Binding/Default.aspx.cs#L22

if(!string.IsNullOrEmpty(EditedDocuemntID)) {
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId);
    EditedDocuemntID = string.Empty;

mvc-gridview-how-to-customize-an-exported-dataaware-excel-file-t385649/CS/T385649/Controllers/HomeController.cs#L30

byte[] result = mySpreadsheet.SaveCopy(DocumentFormat.Xlsx);
DocumentManager.CloseDocument("myDoc");
Response.Clear();

aspxspreadsheet-how-to-save-and-load-documents-from-a-database-t190812/CS/ASPxSpreadsheetBinding/Default.aspx.cs#L18

if(!string.IsNullOrEmpty(EditedDocumentID)) {
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocumentID).DocumentId);
    EditedDocumentID = string.Empty;

aspxspreadsheet-how-to-download-a-document-on-custom-ribbonitem-click-t623622/CS/ASPxSpreadsheetBinding/Default.aspx.cs#L63

void CloseSpreadsheetDocument() {
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId);
    EditedDocuemntID = string.Empty;

aspxspreadsheet-how-to-use-jsproperties/CS/DXSample/Default.aspx.cs#L26

if (!string.IsNullOrEmpty(EditedDocuemntID)) {
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId);
    EditedDocuemntID = string.Empty;

VB.NET

aspxrichedit-how-to-save-and-load-documents-from-a-database-t352034/VB/ASPxRichEdit_Binding/Default.aspx.vb#L28

If Not String.IsNullOrEmpty(EditedDocuemntID) Then
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId)
    EditedDocuemntID = String.Empty

mvc-gridview-how-to-customize-an-exported-dataaware-excel-file-t385649/VB/T385649/Controllers/HomeController.vb#L30

Dim result() As Byte = mySpreadsheet.SaveCopy(DocumentFormat.Xlsx)
DocumentManager.CloseDocument("myDoc")
Response.Clear()

aspxspreadsheet-how-to-save-and-load-documents-from-a-database-t190812/VB/ASPxSpreadsheetBinding/Default.aspx.vb#L24

If Not String.IsNullOrEmpty(EditedDocumentID) Then
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocumentID).DocumentId)
    EditedDocumentID = String.Empty

aspxspreadsheet-how-to-download-a-document-on-custom-ribbonitem-click-t623622/VB/ASPxSpreadsheetBinding/Default.aspx.vb#L68

Private Sub CloseSpreadsheetDocument()
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId)
    EditedDocuemntID = String.Empty

aspxspreadsheet-how-to-use-jsproperties/VB/DXSample/Default.aspx.vb#L32

If Not String.IsNullOrEmpty(EditedDocuemntID) Then
    DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId)
    EditedDocuemntID = String.Empty