aspnet-devexpress-dot-web-dot-office-dot-documentmanager-dot-closedocument-x28-system-dot-string-x29.md
Closes a document with the specified ID.
Namespace : DevExpress.Web.Office
Assembly : DevExpress.Web.v25.2.dll
NuGet Package : DevExpress.Web
public static void CloseDocument(
string documentId
)
Public Shared Sub CloseDocument(
documentId As String
)
| Name | Type | Description |
|---|---|---|
| documentId | String |
The unique identifier of a document.
|
Office controls (ASPxSpreadsheet and ASPxRichEdit) do not close a document when you open another document or even when you leave a page with the control. The document storage retains the document until it is hibernated and then removed from the memory after a dispose timeout. If the hibernation is disabled, the document remains in the storage until IIS process recycling occurs.
Call the CloseDocument methods to close a document explicitly:
DocumentManager.CloseDocument(ASPxSpreadsheet1.DocumentId);
DocumentManager.CloseDocument(ASPxSpreadsheet1.DocumentId)
Call the CloseAllDocuments() method to close all open documents.
DocumentManager.CloseAllDocuments();
DocumentManager.CloseAllDocuments()
When you close a document, DocumentManager closes it for all users who work on the document. It can cause NullReferenceException and “Your session has expired” errors. To avoid these errors, close unshared documents only.
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.
asp-net-web-forms-richedit-work-with-database/CS/ASPxRichEdit_Binding/Default.aspx.cs#L22
if(!string.IsNullOrEmpty(EditedDocuemntID)) {
DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId);
EditedDocuemntID = string.Empty;
asp-net-web-forms-spreadsheet-work-with-database/CS/ASPxSpreadsheetBinding/Default.aspx.cs#L18
if(!string.IsNullOrEmpty(EditedDocumentID)) {
DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocumentID).DocumentId);
EditedDocumentID = string.Empty;
void CloseSpreadsheetDocument() {
DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId);
EditedDocuemntID = string.Empty;
asp-net-web-forms-richedit-work-with-database/VB/ASPxRichEdit_Binding/Default.aspx.vb#L32
If Not String.IsNullOrEmpty(EditedDocuemntID) Then
Call DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId)
EditedDocuemntID = String.Empty
asp-net-web-forms-spreadsheet-work-with-database/VB/ASPxSpreadsheetBinding/Default.aspx.vb#L28
If Not String.IsNullOrEmpty(EditedDocumentID) Then
Call DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocumentID).DocumentId)
EditedDocumentID = String.Empty
Private Sub CloseSpreadsheetDocument()
Call DocumentManager.CloseDocument(DocumentManager.FindDocument(EditedDocuemntID).DocumentId)
EditedDocuemntID = String.Empty
See Also