ReportDesignerDocument.Close(Boolean) Method

Closes the current designer document.

Namespace: DevExpress.Xpf.Reports.UserDesigner

Assembly: DevExpress.Xpf.ReportDesigner.v24.1.dll

NuGet Package: DevExpress.Wpf.Reporting

Declaration

C#

public bool Close(
    bool force = false
)

VB.NET

Public Function Close(
    force As Boolean = False
) As Boolean

Optional Parameters

Name	Type	Default	Description
force	Boolean	False	true, to disable the confirmation logic; otherwise, false.

Returns

Type	Description
Boolean	true, if the document has been successfully closed; otherwise, false.

Remarks

Use the ReportDesignerDocument.Closing event to perform different actions before the document is closed (e.g., cancel closing). You can also handle the ReportDesignerDocument.Closed event to respond to closing the document.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Close(Boolean) 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#

reporting-wpf-mvvm-manage-report-designer-documents/CS/MainViewModel.cs#L46

public void CloseActiveDocument() {
    ReportDesignerAPI.ActiveDocument.Close(true);
}

VB.NET

reporting-wpf-mvvm-manage-report-designer-documents/VB/MainViewModel.vb#L58

Public Sub CloseActiveDocument()
    ReportDesignerAPI.ActiveDocument.Close(True)
End Sub