NeoBookInterfaceHelper.cs

using System;
using System.Runtime.InteropServices;
using System.Threading;
using System.Windows.Forms;

namespace VisualNeoWinPlugin
{
    /// <summary>
    /// Helper class for accessing VisualNEO Win's design-time interface
    /// This class provides easy-to-use methods for common interface operations
    /// </summary>
    public static class NeoBookInterfaceHelper
    {
        #region Windows API Functions
        
        [DllImport("user32.dll")]
        static extern bool SetForegroundWindow(IntPtr hWnd);
        
        [DllImport("user32.dll")]
        static extern IntPtr SetActiveWindow(IntPtr hWnd);

        #endregion

        #region Interface Methods

        /// <summary>
        /// Calls NeoBook interface with proper handling for frameless dialogs (like object selection - ID 8)
        /// This method hides the calling form temporarily to avoid window focus conflicts
        /// </summary>
        /// <param name="callingForm">The form making the call (will be hidden temporarily)</param>
        /// <param name="interfaceId">The interface ID to call</param>
        /// <param name="outputData">The data returned from the interface</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool CallInterfaceWithFormHiding(Form callingForm, int interfaceId, out string outputData)
        {
            outputData = string.Empty;
            IntPtr dataPtr = IntPtr.Zero;
            
            // Store original form state
            FormWindowState originalState = callingForm.WindowState;
            bool originalVisible = callingForm.Visible;
            
            try
            {
                // Make sure nbInterface is not null
                if (Class1.nbInterface == null)
                {
                    MessageBox.Show("nbInterface is null - plugin not properly initialized", "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
                    return false;
                }
                
                // Hide the calling form completely to avoid interference
                callingForm.WindowState = FormWindowState.Minimized;
                callingForm.Visible = false;
                
                // If we have the NeoBook window handle, make it active
                if (Class1.nbWinHandle != IntPtr.Zero)
                {
                    SetForegroundWindow(Class1.nbWinHandle);
                    SetActiveWindow(Class1.nbWinHandle);
                }
                
                // Give time for window state changes to take effect
                Application.DoEvents();
                Thread.Sleep(200);
                
                // Now make the interface call
                bool result = Class1.nbInterface(interfaceId, out dataPtr);
                
                // If successful, read the output data
                if (result && dataPtr != IntPtr.Zero)
                {
                    outputData = Marshal.PtrToStringAnsi(dataPtr);
                }
                
                return result;
            }
            catch (Exception ex)
            {
                MessageBox.Show($"Exception in interface call: {ex.Message}", "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
                return false;
            }
            finally
            {
                // Always restore the form to its original state
                callingForm.Visible = originalVisible;
                callingForm.WindowState = originalState;
                if (originalVisible)
                {
                    callingForm.BringToFront();
                    callingForm.Activate();
                }
            }
        }

        /// <summary>
        /// Calls NeoBook interface with simple approach for framed dialogs (like variable selection - ID 14)
        /// This method keeps the calling form visible
        /// </summary>
        /// <param name="interfaceId">The interface ID to call</param>
        /// <param name="outputData">The data returned from the interface</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool CallInterfaceSimple(int interfaceId, out string outputData)
        {
            outputData = string.Empty;
            IntPtr dataPtr = IntPtr.Zero;
            
            try
            {
                // Make sure nbInterface is not null
                if (Class1.nbInterface == null)
                {
                    MessageBox.Show("nbInterface is null - plugin not properly initialized", "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
                    return false;
                }
                
                // For framed dialogs, just a simple call works fine
                bool result = Class1.nbInterface(interfaceId, out dataPtr);
                
                // If successful, read the output data
                if (result && dataPtr != IntPtr.Zero)
                {
                    outputData = Marshal.PtrToStringAnsi(dataPtr);
                }
                
                return result;
            }
            catch (Exception ex)
            {
                MessageBox.Show($"Exception in interface call: {ex.Message}", "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
                return false;
            }
        }

        #endregion

        #region Convenience Methods

        /// <summary>
        /// Convenience method for object selection (Interface ID 8 - Rectangle objects only)
        /// Note: This is for frameless dialogs that need special handling
        /// </summary>
        /// <param name="callingForm">The form making the call</param>
        /// <param name="selectedObject">The selected object name</param>
        /// <returns>True if an object was selected, false otherwise</returns>
        public static bool SelectObject(Form callingForm, out string selectedObject)
        {
            return CallInterfaceWithFormHiding(callingForm, 8, out selectedObject);
        }

        /// <summary>
        /// Convenience method for general object selection (Interface ID 1 - All objects)
        /// </summary>
        /// <param name="selectedObject">The selected object name</param>
        /// <returns>True if an object was selected, false otherwise</returns>
        public static bool SelectAnyObject(out string selectedObject)
        {
            return CallInterfaceSimple(1, out selectedObject);
        }

        /// <summary>
        /// Convenience method for variable selection (Interface ID 14)
        /// </summary>
        /// <param name="selectedVariable">The selected variable name</param>
        /// <returns>True if a variable was selected, false otherwise</returns>
        public static bool SelectVariable(out string selectedVariable)
        {
            return CallInterfaceSimple(14, out selectedVariable);
        }

        /// <summary>
        /// Convenience method for action editor (Interface ID 2)
        /// </summary>
        /// <param name="actionScript">The action script</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool EditAction(out string actionScript)
        {
            return CallInterfaceSimple(2, out actionScript);
        }

        /// <summary>
        /// Get list of page titles (Interface ID 3)
        /// </summary>
        /// <param name="pageTitles">List of page titles separated by carriage returns</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool GetPageTitles(out string pageTitles)
        {
            return CallInterfaceSimple(3, out pageTitles);
        }

        /// <summary>
        /// Get list of functions (Interface ID 4)
        /// </summary>
        /// <param name="functions">List of functions separated by carriage returns</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool GetFunctions(out string functions)
        {
            return CallInterfaceSimple(4, out functions);
        }

        /// <summary>
        /// Get list of subroutines (Interface ID 5)
        /// </summary>
        /// <param name="subroutines">List of subroutines separated by carriage returns</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool GetSubroutines(out string subroutines)
        {
            return CallInterfaceSimple(5, out subroutines);
        }

        /// <summary>
        /// Show color selection dialog (Interface ID 10)
        /// </summary>
        /// <param name="selectedColor">The selected color as a string</param>
        /// <returns>True if a color was selected, false otherwise</returns>
        public static bool SelectColor(out string selectedColor)
        {
            return CallInterfaceSimple(10, out selectedColor);
        }

        /// <summary>
        /// Show embedded files dialog (Interface ID 13)
        /// </summary>
        /// <param name="result">Result from the dialog</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool ShowEmbeddedFiles(out string result)
        {
            return CallInterfaceSimple(13, out result);
        }

        /// <summary>
        /// Get VisualNEO Win version (Interface ID 6)
        /// </summary>
        /// <param name="version">Version string</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool GetVersion(out string version)
        {
            return CallInterfaceSimple(6, out version);
        }

        /// <summary>
        /// Get current publication path and filename (Interface ID 12)
        /// </summary>
        /// <param name="pubPath">Path to the .pub file</param>
        /// <returns>True if successful, false otherwise</returns>
        public static bool GetPublicationPath(out string pubPath)
        {
            return CallInterfaceSimple(12, out pubPath);
        }

        #endregion
    }
}