3rdpartylibs/fastreports.wpf/FastReport.DesignExt/Design/DesignerSettings.cs

using System;
using System.Collections.Generic;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;
using System.IO;
using System.Data.Common;
using FastReport.Data;
using FastReport.Preview;
using FastReport.Utils;
using System.Threading.Tasks;

namespace FastReport.Design
{
    /// <summary>
    /// This class contains settings that will be applied to the report designer.
    /// </summary>
    [TypeConverter(typeof(FastReport.TypeConverters.FRExpandableObjectConverter))]
    public class DesignerSettings
    {
        private Icon icon;
        private Font defaultFont;
        private bool showInTaskbar;
        private string text;
        private DesignerRestrictions restrictions;
        private List<ConnectionEntry> customConnections;
        private DbConnection applicationConnection;
        private Type applicationConnectionType;
        private ToolStripRenderer toolStripRenderer;
        private static int openDialogFilterIndex = 1;

        /// <summary>
        /// Occurs when the designer is loaded.
        /// </summary>
        /// <remarks>
        /// Use this event if you want to customize some aspects of the designer, for example,
        /// to hide some menu items.
        /// </remarks>
        /// <example>
        /// This example demonstrates how to hide the "File|Select Language..." menu item.
        /// <code>
        /// Config.DesignerSettings.DesignerLoaded += new EventHandler(DesignerSettings_DesignerLoaded);
        ///
        /// void DesignerSettings_DesignerLoaded(object sender, EventArgs e)
        /// {
        ///   (sender as DesignerControl).MainMenu.miFileSelectLanguage.Visible = false;
        /// }
        /// </code>
        /// </example>
        public event EventHandler DesignerLoaded;

        /// <summary>
        /// Occurs when the designer is closed.
        /// </summary>
        public event EventHandler DesignerClosed;

        /// <summary>
        /// Occurs when the report is loaded.
        /// </summary>
        public event ReportLoadedEventHandler ReportLoaded;

        /// <summary>
        /// Occurs when a report page or a dialog form is added to the report.
        /// </summary>
        /// <remarks>
        /// Use this event if you want to customize the page properties.
        /// </remarks>
        /// <example>
        /// This example demonstrates how to change the default page margins.
        /// <code>
        /// Config.DesignerSettings.PageAdded += new EventHandler(DesignerSettings_PageAdded);
        ///
        /// void DesignerSettings_PageAdded(object sender, EventArgs e)
        /// {
        ///   if (sender is ReportPage)
        ///     (sender as ReportPage).TopMargin = 0;
        /// }
        /// </code>
        /// </example>
        public event EventHandler PageAdded;

        /// <summary>
        /// Occurs when object is inserted.
        /// </summary>
        public event ObjectInsertedEventHandler ObjectInserted;

        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Topics/EnvironmentSettings/CustomOpenDialog/*'/>
        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Examples/EnvironmentSettings/*'/>
        public event OpenSaveDialogEventHandler CustomOpenDialog;

        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Topics/EnvironmentSettings/CustomSaveDialog/*'/>
        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Examples/EnvironmentSettings/*'/>
        public event OpenSaveDialogEventHandler CustomSaveDialog;

        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Topics/EnvironmentSettings/CustomOpenReport/*'/>
        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Examples/EnvironmentSettings/*'/>
        public event OpenSaveReportEventHandler CustomOpenReport;

        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Topics/EnvironmentSettings/CustomSaveReport/*'/>
        /// <include file='../../FastReport/Resources/doc.xml' path='//CodeDoc/Examples/EnvironmentSettings/*'/>
        public event OpenSaveReportEventHandler CustomSaveReport;

        /// <summary>
        /// Occurs when previewing a report from the designer.
        /// </summary>
        /// <remarks>
        /// Use this event to show own preview window.
        /// </remarks>
        /// <example>
        /// <code>
        /// Config.DesignerSettings.CustomPreviewReport += new EventHandler(MyPreviewHandler);
        ///
        /// private void MyPreviewHandler(object sender, EventArgs e)
        /// {
        ///   Report report = sender as Report;
        ///   using (MyPreviewForm form = new MyPreviewForm())
        ///   {
        ///     report.Preview = form.previewControl1;
        ///     report.ShowPreparedReport();
        ///     form.ShowDialog();
        ///   }
        /// }
        /// </code>
        /// </example>
        public event EventHandler CustomPreviewReport;

        /// <summary>
        /// Occurs when getting available table names from the connection.
        /// </summary>
        /// <remarks>
        /// Use this handler to filter the list of tables returned by the connection object.
        /// </remarks>
        /// <example>
        /// This example demonstrates how to hide the table with "Table 1" name from the Data Wizard.
        /// <code>
        /// Config.DesignerSettings.FilterConnectionTables += DesignerSettings_FilterConnectionTables;
        ///
        /// private void DesignerSettings_FilterConnectionTables(object sender, FilterConnectionTablesEventArgs e)
        /// {
        ///   if (e.TableName == "Table 1")
        ///     e.Skip = true;
        /// }
        /// </code>
        /// </example>
        public event FilterConnectionTablesEventHandler FilterConnectionTables;

        /// <summary>
        /// Occurs when the query builder is called.
        /// </summary>
        /// <remarks>
        /// Subscribe to this event if you want to replace the embedded query builder with your own one.
        /// </remarks>
        public event CustomQueryBuilderEventHandler CustomQueryBuilder;

        /// <summary>
        /// Gets or sets the icon for the designer window.
        /// </summary>
        public Icon Icon
        {
            get { return icon; }
            set { icon = value; }
        }

        /// <summary>
        /// Gets or sets the default font used in a report.
        /// </summary>
        public Font DefaultFont
        {
            get { return defaultFont; }
            set { defaultFont = value; }
        }

        /// <summary>
        /// Gets or sets a value indicating whether the designer window is displayed in the Windows taskbar.
        /// </summary>
        [DefaultValue(false)]
        public bool ShowInTaskbar
        {
            get { return showInTaskbar; }
            set { showInTaskbar = value; }
        }

        /// <summary>
        /// Gets the designer restrictions flags.
        /// </summary>
        public DesignerRestrictions Restrictions
        {
            get { return restrictions; }
            set { restrictions = value; }
        }

        /// <summary>
        /// Gets or sets the title text for the designer window.
        /// </summary>
        /// <remarks>
        /// If no text is set, the default text "FastReport -" will be used.
        /// </remarks>
        public string Text
        {
            get { return text; }
            set { text = value; }
        }

        /// <summary>
        /// Gets or sets a value indicating whether the preview window is embedded into the designer form.
        /// </summary>
        public bool EmbeddedPreview { get; set; }

        /// <summary>
        /// Gets or sets application-defined DbConnection object that will be used in the designer
        /// to create a new datasource.
        /// </summary>
        /// <remarks>
        /// The application connection object is used in the "Data Wizard" to create new datasources.
        /// In this mode, you can't create any other connections in the wizard; only application
        /// connection is available. You still able to choose tables or create a new queries inside
        /// this connection. The connection information (ConnectionString) is not stored in the report file.
        /// </remarks>
        public DbConnection ApplicationConnection
        {
            get { return applicationConnection; }
            set
            {
                // be sure that add-ins were initialized
                Report dummyReport = new Report();
                dummyReport.Dispose();

                applicationConnection = value;
                FindConnectorType();
            }
        }

        /// <summary>
        /// Gets the toolstrip renderer.
        /// </summary>
        [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
        public ToolStripRenderer ToolStripRenderer
        {
            get
            {
                if (toolStripRenderer == null)
                {
                    ProfessionalColorTable vs2005ColorTable = new ProfessionalColorTable();
                    vs2005ColorTable.UseSystemColors = true;
                    toolStripRenderer = new ToolStripProfessionalRenderer(vs2005ColorTable);
                }
                return toolStripRenderer;
            }
        }

        internal Type ApplicationConnectionType
        {
            get { return applicationConnectionType; }
        }

        internal List<ConnectionEntry> CustomConnections
        {
            get { return customConnections; }
        }

        private void FindConnectorType()
        {
            applicationConnectionType = null;
            if (applicationConnection == null)
                return;

            // find appropriate connector
            var dataConnections = new List<DataConnectionInfo>();
            RegisteredObjects.DataConnections.EnumItems(dataConnections);

            foreach (var dataConnection in dataConnections)
            {
                if (dataConnection.Object != null)
                {
                    // MsAccessDataConnection is the subclass of OleDBDataConnection, skip it
                    if (dataConnection.Object.Name == "MsAccessDataConnection")
                        continue;
                    using (DataConnectionBase conn = Activator.CreateInstance(dataConnection.Object) as DataConnectionBase)
                    {
                        if (conn.GetConnectionType() == applicationConnection.GetType())
                        {
                            applicationConnectionType = conn.GetType();
                            return;
                        }
                    }
                }
            }

            throw new Exception(applicationConnection.GetType().Name + " connection is not supported.");
        }

        internal void OnDesignerLoaded(object sender, EventArgs e)
        {
            if (DesignerLoaded != null)
                DesignerLoaded(sender, e);
        }

        internal void OnDesignerClosed(object sender, EventArgs e)
        {
            if (DesignerClosed != null)
                DesignerClosed(sender, e);
        }

        internal void OnReportLoaded(object sender, ReportLoadedEventArgs e)
        {
            if (ReportLoaded != null)
                ReportLoaded(sender, e);
        }

        internal void OnPageAdded(object sender, EventArgs e)
        {
            if (PageAdded != null)
                PageAdded(sender, e);
        }

        internal void OnObjectInserted(object sender, ObjectInsertedEventArgs e)
        {
            if (ObjectInserted != null)
                ObjectInserted(sender, e);
        }

        internal void OnCustomOpenDialog(object sender, OpenSaveDialogEventArgs e)
        {
            if (CustomOpenDialog != null)
                CustomOpenDialog(sender, e);
            else
            {
                // standard open dialog
                using (OpenFileDialog dialog = new OpenFileDialog())
                {
                    List<ImportPlugin> importPlugins = new List<ImportPlugin>();
                    string filter = Res.Get("FileFilters,Report");

                    foreach (IDesignerPlugin plugin in e.Designer.Plugins)
                    {
                        if (plugin is ImportPlugin)
                        {
                            importPlugins.Add(plugin as ImportPlugin);
                            filter += "|" + (plugin as ImportPlugin).Filter;
                        }
                    }

                    dialog.Filter = filter;
                    dialog.FilterIndex = openDialogFilterIndex;

                    e.Cancel = dialog.ShowDialog() != DialogResult.OK;
                    e.FileName = dialog.FileName;

                    if (!e.Cancel)
                    {
                        openDialogFilterIndex = dialog.FilterIndex;
                    }
                    if (dialog.FilterIndex > 1 && dialog.FilterIndex < (importPlugins.Count + 2))
                    {
                        e.Data = importPlugins[dialog.FilterIndex - 2];
                    }
                }
            }
        }

        internal void OnCustomSaveDialog(object sender, OpenSaveDialogEventArgs e)
        {
            if (CustomSaveDialog != null)
                CustomSaveDialog(sender, e);
            else
            {
                // standard save dialog
                using (SaveFileDialog dialog = new SaveFileDialog())
                {
                    dialog.InitialDirectory = Config.SaveFolder;
                    string filter = Res.Get("FileFilters,Report");
                    if (e.Designer.ActiveReport.ScriptLanguage == Language.CSharp)
                        filter += "|" + Res.Get("FileFilters,CsFile");
                    else
                        filter += "|" + Res.Get("FileFilters,VbFile");

                    List<ExportPlugin> exportPlugins = new List<ExportPlugin>();
                    foreach (IDesignerPlugin plugin in e.Designer.Plugins)
                    {
                        if (plugin is ExportPlugin)
                        {
                            exportPlugins.Add(plugin as ExportPlugin);
                            filter += "|" + (plugin as ExportPlugin).Filter;
                        }
                    }

                    dialog.Filter = filter;
                    dialog.FileName = e.FileName;
                    dialog.DefaultExt = "frx";

                    e.Cancel = dialog.ShowDialog() != DialogResult.OK;
                    // SaveFileDialog bug workaround
                    string[] filters = dialog.Filter.Split('|');
                    string ext = Path.GetExtension(filters[(dialog.FilterIndex - 1) * 2 + 1]);
                    e.FileName = Path.ChangeExtension(dialog.FileName, ext);

                    if (dialog.FilterIndex != 1)
                    {
                        if (dialog.FilterIndex > 2)
                        {
                            e.Data = exportPlugins[dialog.FilterIndex - 3];
                        }
                        else
                        {
                            e.Data = dialog.FilterIndex;
                        }
                        e.IsPlugin = true;
                    }
                }
            }
        }

        internal void OnOpenViaCloudReport(object sender, OpenSaveReportEventArgs e, Stream reportStream = null)
        {
            // standard open report
            if (e.Data == null)
            {
                e.Report.Load(reportStream);
            }
            OnReportLoaded(sender, new ReportLoadedEventArgs(e.Report));
        }

        internal void OnCustomOpenReport(object sender, OpenSaveReportEventArgs e)
        {
            if (CustomOpenReport != null)
                CustomOpenReport(sender, e);
            else
            {
                if (e.Data == null)
                {
                    // standard open report
                    try
                    {
                        e.Report.Load(e.FileName);
                    }
                    catch (DecryptException)
                    {
                        e.Report.Password = e.Report.ShowPasswordForm();
                        e.Report.Load(e.FileName);
                    }
                }
                else
                {
                    (e.Data as ImportPlugin).LoadReport(e.Report, e.FileName);
                }
            }
            OnReportLoaded(sender, new ReportLoadedEventArgs(e.Report));
        }

        internal void OnCustomSaveReport(object sender, OpenSaveReportEventArgs e)
        {
            if (CustomSaveReport != null)
                CustomSaveReport(sender, e);
            else
            {
                // standard save report
                if (e.Data == null)
                    e.Report.Save(e.FileName);
                else
                {
                    if (e.Data is ExportPlugin)
                    {
                        (e.Data as ExportPlugin).SaveReport(e.Report, e.FileName);
                    }
                    else
                    {
                        e.Report.GenerateReportAssembly(e.FileName);
                    }
                }
            }
        }

        internal void OnSaveReportWithRandomData(object sender, OpenSaveReportEventArgs e)
        {
            e.Report.SaveWithRandomData(e.FileName);
        }

        internal async Task OnCustomPreviewReport(object sender, EventArgs e)
        {
#if Demo && !AVALONIA
            Throttle.Execute(() => FRMessageBox.Information("Demo version"), 1500);
#endif
            Report report = sender as Report;
            if (CustomPreviewReport != null)
            {
                if (report.Prepare())
                    CustomPreviewReport(report, e);
            }
            else if (EmbeddedPreview && report.Designer.FindForm().Name == "DesignerForm")
            {
                await report.Designer.ShowEmbeddedPreview(report);
            }
            else
            {
                PreviewControl savePreview = report.Preview;
                report.Preview = null;

                try
                {
                    report.Show();
                }
                finally
                {
                    report.Preview = savePreview;
                }
            }
        }

        internal void OnFilterConnectionTables(object sender, FilterConnectionTablesEventArgs e)
        {
            if (FilterConnectionTables != null)
                FilterConnectionTables(sender, e);
        }

        internal void OnCustomQueryBuilder(object sender, CustomQueryBuilderEventArgs e)
        {
            if (CustomQueryBuilder != null)
                CustomQueryBuilder(sender, e);
            else
            {
                FastReport.FastQueryBuilder.QueryBuilder qb = new FastReport.FastQueryBuilder.QueryBuilder(e.Connection);
                qb.UseJoin = true;
                qb.SetSql(e.SQL);
                if (qb.DesignQuery() == DialogResult.OK)
                    e.SQL = qb.GetSql();
            }
        }

        /// <summary>
        /// Adds a custom connection used in the "Data Wizard" window.
        /// </summary>
        /// <remarks>
        /// Use this method to provide own connection strings for the "Data Wizard" dialog. To do this, you need
        /// to pass the type of connection object and connection string associated with it. You must use one of the
        /// connection objects registered in FastReport that inherit from the
        /// <see cref="FastReport.Data.DataConnectionBase"/> class.
        /// <para/>To clear the custom connections, use the <see cref="ClearCustomConnections"/> method.
        /// </remarks>
        /// <example>
        /// This example shows how to add own connection string.
        /// <code>
        /// Config.DesignerSettings.AddCustomConnection(typeof(MsAccessDataConnection), @"Data Source=c:\data.mdb");
        /// </code>
        /// </example>
        public void AddCustomConnection(Type connectionType, string connectionString)
        {
            if (!connectionType.IsSubclassOf(typeof(DataConnectionBase)))
                throw new Exception("The 'connectionType' parameter should be of the 'DataConnectionBase' type.");

            customConnections.Add(new ConnectionEntry(connectionType, connectionString));
        }

        /// <summary>
        /// Clears the custom connections added by the <b>AddCustomConnection</b> method.
        /// </summary>
        public void ClearCustomConnections()
        {
            customConnections.Clear();
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="DesignerSettings"/> class.
        /// </summary>
        public DesignerSettings()
        {
            icon = ResourceLoader.GetIcon("icon16.ico");
            defaultFont = DrawUtils.DefaultReportFont;
            restrictions = new DesignerRestrictions();
            text = "";
            customConnections = new List<ConnectionEntry>();
        }
    }

    internal class ConnectionEntry
    {
        public Type type;
        public string connectionString;

        public ConnectionEntry(Type type, string connectionString)
        {
            this.type = type;
            this.connectionString = connectionString;
        }
    }
}