HYTOS

/*---------------------------------------------------------------------+\

|                                                                       |

|        Copyright 2016 Intergraph Corporation                          |

|        All Rights Reserved                                            |

|                                                                       |

|        Including software, file formats, and audio-visual displays;   |

|        may only be used pursuant to applicable software license       |

|        agreement; contains confidential and proprietary information of|

|        Intergraph and/or third parties which is protected by copyright|

|        and trade secret law and may not be provided or otherwise made |

|        available without proper authorization.                        |

|                                                                       |

|        Unpublished -- rights reserved under the Copyright Laws of the |

|        United States.                                                 |

|                                                                       |

|        Intergraph Corporation                                         |

|        Huntsville, Alabama         35894-0001                         |

|                                                                       |

\+---------------------------------------------------------------------*/

using System;

namespace Converter.SPPID.Wrapper

{

    /// <summary>

    /// This command class is the mechanism by which the Intergraph application

    /// communicates with the command.

    /// </summary>

    public class SPPIDConverter_Wrapper : IDisposable

    {

        /// <remark>

        /// Declare the form as member data of this class such that each new

        /// instance of the command gets its own form.

        /// </remark>

        private SPPIDConverterWrapper sPPIDConverterDialogBarWrapper;

        /// <summary>

        /// Initialize the class and use the member form such that each new 

        /// instance of the command gets it own form.

        /// </summary>

        public SPPIDConverter_Wrapper()

        {

            sPPIDConverterDialogBarWrapper = new SPPIDConverterWrapper();

        }

        /// <summary>

        /// This function lets the Intergraph application communicate with

        /// the command.

        /// </summary>

        /// <param name="basicCommand">The basic command</param>

        public void Command_Initialize(ref object basicCommand)

        {

            sPPIDConverterDialogBarWrapper.commandControl.Command = basicCommand;

        }

        /// <summary>

        /// Gets the description.

        /// </summary>

        /// <value>

        /// The description of the command as assigned in the resources file.

        /// </value>

        public string Description

        {

            get

            {

                return Properties.Resources.ResourceManager.GetString("Description", System.Globalization.CultureInfo.CurrentCulture);

            }

        }

        /// <summary>

        /// Gets the tooltip of the command.

        /// </summary>

        /// <value>

        /// The tooltip of the command as assigned in the resources file.

        /// </value>

        public string GetTooltip

        {

            get

            {

                return Properties.Resources.ResourceManager.GetString("Tooltip", System.Globalization.CultureInfo.CurrentCulture);

            }

        }

        /// <summary>

        /// Gets the toolbar image.

        /// </summary>

        /// <value>

        /// The toolbar image of the command as assigned in the resources file.

        /// </value>

        public System.Drawing.Image ToolbarImage

        {

            get

            {

                return (System.Drawing.Image)Properties.Resources.ResourceManager.GetObject("ToolbarImage", System.Globalization.CultureInfo.CurrentCulture);

            }

        }

        /// <summary>

        /// All Macro classes should implement IDisposable and call the dispose over the 

        /// Form on which our RADNetCommandControl lives(i.e Main Form)

        /// </summary>

        void IDisposable.Dispose()

        {

            /* http://stackoverflow.com/questions/3097364/c-sharp-form-close-vs-form-dispose

             * http://www.alwaysgetbetter.com/blog/2008/04/04/c-formclose-vs-formdispose/

             * From the above thread in case of Modal forms we need to explicitly dispose 

             * the form. Don't call Close here. Form should only be closed when user 

             * explicitly does it either via Code or Interactively. Using Close will cause 

             * re-entrance in the form's close event handlers when the form is closed 

             * explicitly and Done property is set to True. In all the other cases where 

             * Macro is Terminated this method is called by RADNetLoader.

             */

            sPPIDConverterDialogBarWrapper.Dispose(); // This helps in the destruction of underlying COM Command.

        }

    }

}