{"id":41,"date":"2015-11-18T16:08:58","date_gmt":"2015-11-18T16:08:58","guid":{"rendered":"http:\/\/o-calcpro.com\/wiki\/?p=41"},"modified":"2015-11-18T20:56:16","modified_gmt":"2015-11-18T20:56:16","slug":"o-calc-pro-plugin-hello-world","status":"publish","type":"post","link":"http:\/\/o-calcpro.com\/wiki\/2015\/11\/18\/o-calc-pro-plugin-hello-world\/","title":{"rendered":"O-Calc Pro Plugin \u2013 \u201cHello World\u201d"},"content":{"rendered":"

The default O-Calc Pro Plugin<\/em><\/strong> template will create a message box showing the message “Hello World”. Below are some explanations of the various code components of this simple plugin example.<\/p>\n

Defining the Plugin Type:<\/h3>\n
\n\n\t\t
\n\n\t\t
\n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
C#<\/div>\n\n\t\t\n\t\t
\n\n\t<\/div>\n\t\n\t
\n\t\t
  1. \/\/\/ <summary><\/span><\/div><\/li>\n
  2. \/\/\/ Declare the type of plugin as one of:<\/span><\/div><\/li>\n
  3. \/\/\/         DOCKED_TAB<\/span><\/div><\/li>\n
  4. \/\/\/         MENU_ITEM<\/span><\/div><\/li>\n
  5. \/\/\/         BOTH_DOCKED_AND_MENU<\/span><\/div><\/li>\n
  6. \/\/\/         CLEARANCE_SAG_PROVIDER<\/span><\/div><\/li>\n
  7. \/\/\/ <\/summary><\/span><\/div><\/li>\n
  8.     public<\/span> PLUGIN_TYPE Type<\/div><\/li>\n
  9.     {<\/span><\/div><\/li>\n
  10.       get<\/span><\/div><\/li>\n
  11.          {<\/span><\/div><\/li>\n
  12.           return<\/span> PLUGIN_TYPE.<\/span>BOTH_DOCKED_AND_MENU<\/span>;<\/span><\/div><\/li>\n
  13.          }<\/span><\/div><\/li>\n
  14.     }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

    There are four different plug-in types that can be defined. In the code snippet above, the plugin type as been defined as both a ‘Menu Item’ and a new ‘Docked Tab’.<\/p>\n

    Naming the Plugin:<\/h3>\n
    \n\n\t\t
    \n\n\t\t
    \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
    C#<\/div>\n\n\t\t\n\t\t
    \n\n\t<\/div>\n\t\n\t
    \n\t\t
    1. \/\/\/ <summary><\/span><\/div><\/li>\n
    2. \/\/\/ Declare the name of the plugin usd for synthesizing the registry keys ect<\/span><\/div><\/li>\n
    3. \/\/\/ <\/summary><\/span><\/div><\/li>\n
    4.     public<\/span> String<\/span> Name<\/div><\/li>\n
    5.         {<\/span><\/div><\/li>\n
    6.          get<\/span><\/div><\/li>\n
    7.            {<\/span><\/div><\/li>\n
    8.              return<\/span> "MyOCalcProPlugin"<\/span>;<\/span><\/div><\/li>\n
    9.             }<\/span><\/div><\/li>\n
    10.         }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

      This will be the name of the menu item as it appears in the O-Calc Pro interface. To change the name of the resultant compiled plugin file that gets built to the location C:\\Program Files (x86)\\Osmose\\O-Calc Pro\\bin\\Plugins, you would need to change the name of the Visual Studio Project. Note: the name of the compiled plugin file is what will be displayed in the O-Calc Pro ‘Manage Plugins’ list.<\/p>\n

      Specifying the Docked Tab Parameters :<\/h3>\n
      \n\n\t\t
      \n\n\t\t
      \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
      C#<\/div>\n\n\t\t\n\t\t
      \n\n\t<\/div>\n\t\n\t
      \n\t\t
      1. \/\/\/ <summary><\/span><\/div><\/li>\n
      2. \/\/\/ Add a tabbed form to the tabbed window (if the plugin type is <\/span><\/div><\/li>\n
      3. \/\/\/ PLUGIN_TYPE.DOCKED_TAB <\/span><\/div><\/li>\n
      4. \/\/\/ or<\/span><\/div><\/li>\n
      5. \/\/\/ PLUGIN_TYPE.BOTH_DOCKED_AND_MENU<\/span><\/div><\/li>\n
      6. \/\/\/ <\/summary><\/span><\/div><\/li>\n
      7. \/\/\/ <param name="pPPLMain"><\/param><\/span><\/div><\/li>\n
      8.     public<\/span> void<\/span> AddForm(<\/span>PPL_Lib.<\/span>PPLMain<\/span> pPPLMain)<\/span><\/div><\/li>\n
      9.       {<\/span><\/div><\/li>\n
      10.         .<\/span> .<\/span> .<\/span><\/div><\/li>\n
      11.       }<\/span><\/div><\/li>\n
      12.  <\/div><\/li>\n
      13.      PluginForm cForm =<\/span> null<\/span>;<\/span><\/div><\/li>\n
      14.      class<\/span> PluginForm :<\/span> WeifenLuo.<\/span>WinFormsUI<\/span>.<\/span>Docking<\/span>.<\/span>DockContent<\/span><\/div><\/li>\n
      15.      {<\/span><\/div><\/li>\n
      16.        public<\/span> PluginForm(<\/span>)<\/span><\/div><\/li>\n
      17.        {<\/span><\/div><\/li>\n
      18.           this<\/span>.<\/span>Name<\/span> =<\/span> "pluginForm"<\/span>;<\/span><\/div><\/li>\n
      19.           this<\/span>.<\/span>Text<\/span> =<\/span> "Plugin"<\/span>;<\/span><\/div><\/li>\n
      20.           System<\/span>.<\/span>Windows<\/span>.<\/span>Forms<\/span>.<\/span>Label<\/span> helloLabel =<\/span> new<\/span> System<\/span>.<\/span>Windows<\/span>.<\/span>Forms<\/span>.<\/span>Label<\/span>(<\/span>)<\/span>;<\/span><\/div><\/li>\n
      21.           helloLabel.<\/span>AutoSize<\/span> =<\/span> true<\/span>;<\/span><\/div><\/li>\n
      22.           helloLabel.<\/span>Name<\/span> =<\/span> "helloLabel"<\/span>;<\/span><\/div><\/li>\n
      23.           helloLabel.<\/span>Text<\/span> =<\/span> "Hello World"<\/span>;<\/span><\/div><\/li>\n
      24.           helloLabel.<\/span>Location<\/span> =<\/span> new<\/span> System.Drawing<\/span><\/span>.<\/span>Point<\/span>(<\/span>20<\/span>, 20<\/span>)<\/span>;<\/span><\/div><\/li>\n
      25.           helloLabel.<\/span>Visible<\/span> =<\/span> true<\/span>;<\/span><\/div><\/li>\n
      26.              Controls.<\/span>Add<\/span>(<\/span>helloLabel)<\/span>;<\/span><\/div><\/li>\n
      27.        }<\/span><\/div><\/li>\n
      28.        public<\/span> Guid cGuid;<\/span><\/div><\/li>\n
      29.        protected<\/span> override<\/span> string<\/span> GetPersistString(<\/span>)<\/span><\/div><\/li>\n
      30.        {<\/span><\/div><\/li>\n
      31.            return<\/span> cGuid.<\/span>ToString<\/span>(<\/span>)<\/span>;<\/span><\/div><\/li>\n
      32.        }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

        Here the developer can specify the various parameters associated with the docked tab, such as tab name, display text, and other features of the new docked tab that will appear within the O-Calc Pro interface.<\/p>\n

        Defining the location of the Menu Item:<\/h3>\n
        \n\n\t\t
        \n\n\t\t
        \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
        C#<\/div>\n\n\t\t\n\t\t
        \n\n\t<\/div>\n\t\n\t
        \n\t\t
        1. public<\/span> void<\/span> AddToMenu(<\/span>PPL_Lib.<\/span>PPLMain<\/span> pPPLMain, System<\/span>.<\/span>Windows<\/span>.<\/span>Forms<\/span>.<\/span>ToolStrip<\/span> pToolStrip)<\/span><\/div><\/li>\n
        2.     {<\/span><\/div><\/li>\n
        3.        \/\/save the reference to the O-Calc Pro main<\/span><\/div><\/li>\n
        4.        cPPLMain =<\/span> pPPLMain;<\/span><\/div><\/li>\n
        5.  <\/div><\/li>\n
        6.        \/\/create the toolstrip button<\/span><\/div><\/li>\n
        7.        cToolStripMenuItemButton =<\/span> new<\/span> ToolStripMenuItem(<\/span>Name)<\/span>;<\/span><\/div><\/li>\n
        8.        cToolStripMenuItemButton.<\/span>AutoToolTip<\/span> =<\/span> true<\/span>;<\/span><\/div><\/li>\n
        9.        cToolStripMenuItemButton.<\/span>ToolTipText<\/span> =<\/span> Description;<\/span><\/div><\/li>\n
        10.  <\/div><\/li>\n
        11.        \/\/find the dropdown menu we want to add the toolsrip button to<\/span><\/div><\/li>\n
        12.        int<\/span> itemindex =<\/span> 0<\/span>;<\/span><\/div><\/li>\n
        13.        System.Diagnostics<\/span><\/span>.<\/span>Debug<\/span>.<\/span>Assert<\/span>(<\/span>pToolStrip.<\/span>Items<\/span>[<\/span>itemindex]<\/span> is<\/span> ToolStripDropDownButton)<\/span>;<\/span><\/div><\/li>\n
        14.        if<\/span> (<\/span>pToolStrip.<\/span>Items<\/span>[<\/span>itemindex]<\/span> is<\/span> ToolStripDropDownButton)<\/span><\/div><\/li>\n
        15.        {<\/span><\/div><\/li>\n
        16.           ToolStripDropDownButton tsb =<\/span> pToolStrip.<\/span>Items<\/span>[<\/span>itemindex]<\/span> as<\/span> ToolStripDropDownButton;<\/span><\/div><\/li>\n
        17.           System.Diagnostics<\/span><\/span>.<\/span>Debug<\/span>.<\/span>Assert<\/span>(<\/span>tsb.<\/span>Text<\/span> ==<\/span> "&File"<\/span>)<\/span>;<\/span><\/div><\/li>\n
        18.           tsb.<\/span>DropDownItems<\/span>.<\/span>Insert<\/span>(<\/span>tsb.<\/span>DropDownItems<\/span>.<\/span>Count<\/span> -<\/span> 1<\/span>, cToolStripMenuItemButton)<\/span>;<\/span><\/div><\/li>\n
        19.           tsb.<\/span>DropDownItems<\/span>.<\/span>Insert<\/span>(<\/span>tsb.<\/span>DropDownItems<\/span>.<\/span>Count<\/span> -<\/span> 1<\/span>, new<\/span> ToolStripSeparator(<\/span>)<\/span>)<\/span>;<\/span><\/div><\/li>\n
        20.  <\/div><\/li>\n
        21.           \/\/add an event handler when the dropdown menu is opened to allow us<\/span><\/div><\/li>\n
        22.           \/\/to enable or disble the toolstrip button (optional)<\/span><\/div><\/li>\n
        23.           tsb.<\/span>DropDownOpened<\/span> +=<\/span> tsb_DropDownOpened;<\/span><\/div><\/li>\n
        24.       }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

          In the default code snippet above, the new menu item is placed at the bottom of the ‘File’ drop down menu. This menu item will be disabled until a pole has been loaded within the application.<\/p>\n

          \n\n\t\t
          \n\n\t\t
          \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
          C#<\/div>\n\n\t\t\n\t\t
          \n\n\t<\/div>\n\t\n\t
          \n\t\t
          1. \/\/\/ <summary><\/span><\/div><\/li>\n
          2. \/\/\/ The menu containing our tool is being displayed.  Optionally<\/span><\/div><\/li>\n
          3. \/\/\/ enable or disable the toolstrip button depending on<\/span><\/div><\/li>\n
          4. \/\/\/ our criteria<\/span><\/div><\/li>\n
          5. \/\/\/ <\/summary><\/span><\/div><\/li>\n
          6. \/\/\/ <param name="sender"><\/param><\/span><\/div><\/li>\n
          7. \/\/\/ <param name="e"><\/param><\/span><\/div><\/li>\n
          8.     void<\/span> tsb_DropDownOpened(<\/span>object<\/span> sender, EventArgs e)<\/span><\/div><\/li>\n
          9.    {<\/span><\/div><\/li>\n
          10.         bool<\/span> enabled =<\/span> false<\/span>;<\/span><\/div><\/li>\n
          11.         if<\/span> (<\/span>cPPLMain !=<\/span> null<\/span>)<\/span><\/div><\/li>\n
          12.        {<\/span><\/div><\/li>\n
          13.            enabled =<\/span> (<\/span>cPPLMain.<\/span>GetMainStructure<\/span>(<\/span>)<\/span> is<\/span> PPLPole)<\/span>;<\/span><\/div><\/li>\n
          14.        }<\/span><\/div><\/li>\n
          15.         cToolStripMenuItemButton.<\/span>Enabled<\/span> =<\/span> enabled;<\/span><\/div><\/li>\n
          16.    }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

            Perform the Plugin Operation<\/h3>\n
            \n\n\t\t
            \n\n\t\t
            \n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
            C#<\/div>\n\n\t\t\n\t\t
            \n\n\t<\/div>\n\t\n\t
            \n\t\t
            1. \/\/\/ <summary><\/span><\/div><\/li>\n
            2. \/\/\/ Perform the plugin tool's operation<\/span><\/div><\/li>\n
            3. \/\/\/ <\/summary><\/span><\/div><\/li>\n
            4. private<\/span> void<\/span> DoPluginOperation(<\/span>)<\/span><\/div><\/li>\n
            5. {<\/span><\/div><\/li>\n
            6.       try<\/span><\/div><\/li>\n
            7.       {<\/span><\/div><\/li>\n
            8.           PPLMessageBox.<\/span>Show<\/span>(<\/span>"Hello World!"<\/span>)<\/span>;<\/span><\/div><\/li>\n
            9.       }<\/span><\/div><\/li>\n
            10.       catch<\/span> (<\/span>Exception ex)<\/span><\/div><\/li>\n
            11.       {<\/span><\/div><\/li>\n
            12.           PPLMessageBox.<\/span>Show<\/span>(<\/span>ex.<\/span>Message<\/span>, "Error in "<\/span> +<\/span> Name)<\/span>;<\/span><\/div><\/li>\n
            13.       }<\/span><\/div><\/li>\n
            14. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

              In this example, clicking on the plugin menu item found in the File dropdown, will display the “Hello World” message box.<\/p>\n

              \"\"<\/p>\n

              Below is a video that demonstrates this ‘Hello World’ plugin:<\/p>\n