XRDesignPanel.ReportState Property

Gets the state of the report currently being edited in the Design Panel.

Namespace: DevExpress.XtraReports.UserDesigner

Assembly: DevExpress.XtraReports.v19.1.Extensions.dll

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

[Browsable(false)]
public ReportState ReportState { get; set; }

VB.NET

<Browsable(False)>
Public Property ReportState As ReportState

Property Value

Type	Description
ReportState	A ReportState enumeration value which represents the current state of a report.

Available values:

Name	Description
None	The report’s state is not specified.
Opening	The report is in the process of opening.
Opened	The report is open in the End-User Designer.
Changed	At least one component in the report has been modified.
Saved	The report has been saved to a file.
Closing	The report editing session is being closed.

Remarks

Use the ReportState property, to obtain or modify the current state of the report being edited in the XRDesignPanel. For example, after you’ve manually saved a report in the Design Panel, you should set the ReportState property to ReportState.Saved.

Note

In most cases, you don’t need to manually set the value of the ReportState property, because it’s done automatically.

Example

This example demonstrates how to override and customize saving in the End-User Designer. This can be useful, for example, if all the reports in a project should be stored in a database, and are retrieved from the database via a stream, and all of this should be done automatically, without forcing an end-user to do anything but click the Save (or Save As) toolbar button.

In this example, a report will also be automatically saved using the custom saving procedure when an end-user closes the Report Designer. To implement this task, handle the ReportCommand.SaveFile and ReportCommand.SaveFileAs commands (and, if necessary, the ReportCommand.Closing command, as well).

The following code demonstrates how this can be done.

Form1.cs

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DevExpress.XtraReports.UserDesigner;

namespace CustomSavingEUD
{
    public partial class Form1 : Form
    {
        public Form1() {
            InitializeComponent();
        }

        // Create an MDI (multi-document interface) controller instance.
        XRDesignMdiController mdiController;

        private void button1_Click(object sender, EventArgs e) {
            // Create a design form and get its MDI controller.
            XRDesignForm form = new XRDesignForm();
            mdiController = form.DesignMdiController;

            // Handle the DesignPanelLoaded event of the MDI controller,
            // to override the SaveCommandHandler for every loaded report.
            mdiController.DesignPanelLoaded +=
                new DesignerLoadedEventHandler(mdiController_DesignPanelLoaded);

            // Open an empty report in the form.
            mdiController.OpenReport(new XtraReport1());

            // Show the form.
            form.ShowDialog();
            if (mdiController.ActiveDesignPanel != null) {
                mdiController.ActiveDesignPanel.CloseReport();
            }
        }
        void mdiController_DesignPanelLoaded(object sender, DesignerLoadedEventArgs e) {
            XRDesignPanel panel = (XRDesignPanel)sender;
            panel.AddCommandHandler(new SaveCommandHandler(panel));
        }

        public class SaveCommandHandler : DevExpress.XtraReports.UserDesigner.ICommandHandler {
            XRDesignPanel panel;

            public SaveCommandHandler(XRDesignPanel panel) {
                this.panel = panel;
            }

            public void HandleCommand(DevExpress.XtraReports.UserDesigner.ReportCommand command,
            object[] args) {
                // Save the report.
                Save();
            }

            public bool CanHandleCommand(DevExpress.XtraReports.UserDesigner.ReportCommand command,
            ref bool useNextHandler) {
                useNextHandler = !(command == ReportCommand.SaveFile ||
                    command == ReportCommand.SaveFileAs);
                return !useNextHandler;
            }

            void Save() {
                // Write your custom saving here.
                // ...

                // For instance:
                panel.Report.SaveLayout("c:\\report1.repx");

                // Prevent the "Report has been changed" dialog from being shown.
                panel.ReportState = ReportState.Saved;
            }
        }
    }
}

Form1.vb

Imports System
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Data
Imports System.Drawing
Imports System.Linq
Imports System.Text
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UserDesigner

Namespace CustomSavingEUD
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        ' Create an MDI (multi-document interface) controller instance.
        Private mdiController As XRDesignMdiController

        Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click
            ' Create a design form and get its MDI controller.
            Dim form As New XRDesignForm()
            mdiController = form.DesignMdiController

            ' Handle the DesignPanelLoaded event of the MDI controller,
            ' to override the SaveCommandHandler for every loaded report.
            AddHandler mdiController.DesignPanelLoaded, AddressOf mdiController_DesignPanelLoaded

            ' Open an empty report in the form.
            mdiController.OpenReport(New XtraReport1())

            ' Show the form.
            form.ShowDialog()
            If mdiController.ActiveDesignPanel IsNot Nothing Then
                mdiController.ActiveDesignPanel.CloseReport()
            End If
        End Sub
        Private Sub mdiController_DesignPanelLoaded(ByVal sender As Object, ByVal e As DesignerLoadedEventArgs)
            Dim panel As XRDesignPanel = DirectCast(sender, XRDesignPanel)
            panel.AddCommandHandler(New SaveCommandHandler(panel))
        End Sub

        Public Class SaveCommandHandler
            Implements DevExpress.XtraReports.UserDesigner.ICommandHandler

            Private panel As XRDesignPanel

            Public Sub New(ByVal panel As XRDesignPanel)
                Me.panel = panel
            End Sub

            Public Sub HandleCommand(ByVal command As DevExpress.XtraReports.UserDesigner.ReportCommand, ByVal args() As Object) Implements ICommandHandler.HandleCommand
                ' Save the report.
                Save()
            End Sub

            Public Function CanHandleCommand(ByVal command As DevExpress.XtraReports.UserDesigner.ReportCommand, ByRef useNextHandler As Boolean) As Boolean Implements ICommandHandler.CanHandleCommand
                useNextHandler = Not (command = ReportCommand.SaveFile OrElse command = ReportCommand.SaveFileAs OrElse command = ReportCommand.Closing)
                Return Not useNextHandler
            End Function

            Private Sub Save()
                ' Write your custom saving here.
                ' ...

                ' For instance:
                panel.Report.SaveLayout("c:\report1.repx")

                ' Prevent the "Report has been changed" dialog from being shown.
                panel.ReportState = ReportState.Saved
            End Sub
        End Class
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ReportState property.

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_how-to-suppress-the-report-has-been-changed-do-you-want-to-save-changes-message-t424864/CS/WindowsFormsApplication1/Form2.cs#L51

XRDesignPanel panel = designForm.DesignPanel;
if (panel.ReportState != ReportState.Saved && panel.ReportState != ReportState.None)
{

reporting-winforms-designer-override-commands/CS/CustomSavingEUD/Form1.cs#L74

    // Prevent the "Report has been changed" dialog from being shown.
    panel.ReportState = ReportState.Saved;
}

VB.NET

Reporting_how-to-suppress-the-report-has-been-changed-do-you-want-to-save-changes-message-t424864/VB/WindowsFormsApplication1/Form2.vb#L46

Dim panel As XRDesignPanel = designForm.DesignPanel
If panel.ReportState <> ReportState.Saved AndAlso panel.ReportState <> ReportState.None Then
    MessageBox.Show("Perform report saving here!")

reporting-winforms-designer-override-commands/VB/CustomSavingEUD/Form1.vb#L65

    ' Prevent the "Report has been changed" dialog from being shown.
    panel.ReportState = ReportState.Saved
End Sub