Autocompletion in IDEs for DHTMLX Library

| Comments (47)

We have some exciting news for those of you who are used to work with IDEs and use the autocomplete feature. You now can enjoy autocomplete hints in your favorite IDE while you integrate the DHTMLX components into your web app. We provide the autocompletion plugins for Microsoft Visual Studio, PHPStorm, WebStorm, NetBeans, Aptana Studio, Eclipse, and others.

To add the code completion for DHTMLX library into your IDE:

 
Visual Studio 2010 | Visual Studio 2008

  • copy dhtmlx.debug.js in the same folder where dhtmlx.js is located
  • if you are using an individual component (not dhtmlx.js), rename dhtmlx.debug.js to {component}.debug.js and place in the same folder where the .js file of the component is located
DHTMLX Autocomplete - Visual Studio 2010

Visual Studio 2010 - Autocompletion for DHTMLX

 
PHPStorm | WebStorm (JetBrain IDEs)

  • drop dhtmlx3.sdoc.js in the project
  • you may need to restart IDE after that to force auto-complete reindexing
WebStorm 2.1 - Autocompletion for DHTMLX

WebStorm 2.1 - Autocompletion for DHTMLX

 
NetBeans 7

  • drop dhtlmx3.sdoc in the project
  • select in top menu “Source|Scan for external changes”
NetBeans IDE - Autocompletion for DHTMLX

NetBeans IDE - Autocompletion for DHTMLX

 
Aptana Studio

Aptana Studio 2.x:

  • copy jar file in plugins folder of IDE
  • restart IDE
  • select “References|Global references”
  • check “DHTMLX 3.0” item

 
Aptana Studio 3.x:

  • drop dhtmlx3.vsdoc.js in the project
  • restart IDE
Aptana Studio - Autocompletion for DHTMLX

Aptana Studio - Autocompletion for DHTMLX

 
Eclipse

  • install Eclipse JavaScript Development Tools
  • go to project properties – JavaScript – Include Path
  • click “Add JavaScript Library” – “User Library” – “Configure User Library” – “New”
  • enter “dhtmlx3” as library name
  • select dhtmlx3 from the list and press “Add .js file”, select dhtmlx3.sdoc.js from the download package
  • press “OK” and “Finish” in all dialogs
Eclipse - Autocompletion for DHTMLX

Eclipse - Autocompletion for DHTMLX

 
Komodo IDE and Komodo Editor

  • extract dhtmlx3.sdoc.js from the package to some folder
  • open project properties – Languages – Javascript
  • add above folder to the list of JavaScript directories
Komodo IDE - Autocompletion for DHTMLX

Komodo IDE - Autocompletion for DHTMLX

 
Adobe Dreamweaver

  • copy dhtmlx3.xml (download here) to the %DREAMWEAVER%\configuration\CodeHints\ folder
    (for example, c:\Program Files (x86)\Adobe\Adobe Dreamweaver CS5.5\configuration\CodeHints\ )
  • restart Dreamweaver
  • go to menu Edit -> Preferences -> Code Hints and check “dhtmlx” option in the list of code hints
Dreamweaver - Autocompletion for DHTMLX

Dreamweaver - Autocompletion for DHTMLX

Comments

  1. koby October 11, 2011 at 11:32 am

    Hello all
    It seems that is not working with menu and layout…

    • Ivan October 11, 2011 at 1:39 pm

      This is strange, because everything works fine on our side. Please check that your followed the instructions carefully.

  2. Ben October 11, 2011 at 5:14 pm

    is there likely to be an eclipse plugin in the future?

    • Ivan October 11, 2011 at 8:35 pm

      Yes, we’ll add autocomplete feature for Eclipse in the near future.

      • Emmanuel October 12, 2011 at 1:51 am

        is there any newsletter that i can check to know if the plug-in has been released?

        • Ivan October 13, 2011 at 1:01 pm

          We’ve added the instructions on how to configure autocomplete for Eclipse. The required files can be downloaded here.

  3. Richard October 12, 2011 at 2:46 pm

    Do u have autocompliation for eclipse?

    • Ivan October 13, 2011 at 1:02 pm

      Richard, we’ve updated the post with the instructions for Eclipse.

  4. Gabriele October 13, 2011 at 12:43 pm

    Good Job….but….An autocompliation for Komodo?

    • Ivan October 13, 2011 at 4:08 pm

      Added the instructions for Komodo in the end of the article. The download file is the same.

      • Gabriele October 17, 2011 at 2:52 pm

        Thank you very much!!! Fantastic!

  5. Sushalendra Joshi October 17, 2011 at 1:37 pm

    I am using the eclipse (eclipse-jee-galileo-win32) as my IDE. I followed the instructions as mentioned in above for the eclipse editor. I could not able to get the API list on creating a object as mentioned above. My editor has the following plugins for the Javascript.
    org.eclipse.wst.jsdt.core_1.0.200.v200905201910
    org.eclipse.wst.jsdt.ui_1.0.200.v200905242047
    org.eclipse.wst.jsdt.manipulation_1.0.100.v200809240707
    org.eclipse.wtp.javascript.capabilities_1.0.0.v200906072300.

    Please help out to resolve the issue.

    • Ivan October 17, 2011 at 8:05 pm

      You have some old plugins, in the latest version everything works fine.

  6. Josh Weiss October 21, 2011 at 10:39 pm

    This is great. Also, for Visual Studio you can make this work in .js files as well as in html and aspx files. Just open the js file and drag dhtmlx.debug.js from Solution Explorer to the top of the .js file you’re working in. VS will create a comment with a path to the debug file which will cause Intellisense to work.

  7. André October 24, 2011 at 6:50 pm

    Dreamweaver support would be great!

    • Ivan October 28, 2011 at 7:15 pm

      We’ve added the instructions for Dreamweaver in the end of the article.

  8. Zack C December 15, 2011 at 11:30 pm

    Is there a way in visual studio 2010 to get the autocomplete available when you are in a js file?
    Or does it only work when you are in an a html page with the script tag above?

    • Mike Bremberg December 16, 2011 at 7:38 pm

      you can add in your js file

      ///

      • Mike Bremberg December 16, 2011 at 7:39 pm

        /// <reference path=”dhtmlx.js” />

  9. Alexandre Soares January 20, 2012 at 12:36 am

    I wold like to tell that the feature to add support for eclipse is not very good, because of problems with memory and GC. I had tested here with indigo and compared with visual studio, eclipse is muth worse. IS there any other possibility to have this kind of featured in another way in eclpse?

    I wonder that the problems that I had its envolved with the architecture of eclipse that is not very good for this this kind of feature. Any suggestions?

    • Ivan January 20, 2012 at 6:37 pm

      Unfortunately, we can’t help you with this issue. We just provide the information for autocomplete, but how it works depends on IDE.

      • Alexandre Soares January 20, 2012 at 11:01 pm

        I understand, but my real question is: Is any other way to have code completition in eclipse? Because this way is worthless because we have a lot o problems with memory and garbage collection using this. I heard that maybe DHTMLX would have a eclipse plugin more robust then this feature. Is that true?

  10. Eric January 26, 2012 at 8:23 pm

    Is it possible to get the autocomplete functionality for Microsoft Expression Web 4?

  11. Mike January 27, 2012 at 8:19 pm

    Hi,
    Please add support for JDeveloper 11g.

    Thanks,
    Mike

  12. Max January 28, 2012 at 2:50 pm

    I’ve already autocompletion in netbeans 7.0.1 who scan .js to build is autocompletion for project. I’m going to testing with .sdoc.

    But i’m suggesting to write standard comments on each function to have this Comments during autocompletion on NetBeans :)

    • Stanislav January 30, 2012 at 12:10 pm

      sdoc format is exactly the same thing – standard comments for functions definition.

  13. angeltcho July 11, 2012 at 12:33 pm

    The version for Dreamweaver CS5.5 does not work for me. the downloaded file was put it the corret folder. Restarted DW, checked in Preferences… Nothing. Do you have a tutorial ? thanks

    • Ivan July 23, 2012 at 5:49 pm

      The next 2 steps should be enough:

      – copy dhtmlx3.xml (download here) to the
      %DREAMWEAVER%\\configuration\\CodeHints\\ folder

      – go to menu Edit -> Preferences -> Code Hints and check “dhtmlx” option in the list of code hints

      “the downloaded file was put it the corret folder”
      You have copied not the zip file, but dhtmlx3.xml from it, right?

      • angeltcho August 8, 2012 at 5:21 pm

        Hi Ivan, sorry I’ve just read your answer. Yes I just copied the dhtmlx3.xml file and “dhtmlx” option appears checked in the list of code hints.
        However, when I start typing dhtml… no hint will appear. :-( Did I miss something ?

  14. Dave July 17, 2012 at 7:07 pm

    Dropped the file dhtmlx3.sdoc.js into Komodo and works great when the objects are created using the new method

    ie var grid = new dhtmlxGridObject(); the autocomplete works on grid ..

    however

    var grid = myLayout.cells(‘a’).attachGrid(); the autocomplete does not work on grid …

    Is this to be expected ?

    Thanks

    • Ivan July 23, 2012 at 5:46 pm

      Dave, it looks as a limitation of Komodo javascript auto-suggest system.
      The description files contain all details about attachGrid method but Komodo will do type-applying only on classes created with new.

      We will check how it can be workarounded, but unfortunately there is no simple and fast solution.

  15. Kynao December 4, 2012 at 4:45 am

    Hello,

    Is it updated for dhtmlx 3.5 and phpstorm 5 ?

    • Ivan December 12, 2012 at 5:47 pm

      The files that worked for the older version of PHPStorm will work for the new version as well.

  16. Rimokas December 27, 2012 at 5:04 pm

    It will be very pleasant to get support for notepad ++ . Maybe you have xml file of function , which can be adopted for notepad ++ ? Here is for jQuery : http://www.jamesallardice.com/blog/jquery-code-hinting-in-notepad/

    Many thanks in advance !

    • Ivan December 29, 2012 at 12:46 pm

      Currently we don’t have such a file.
      We will look how it can be added (thanks for helpfull link :)

  17. Rimokas January 15, 2013 at 12:51 pm

    Maybe exist some news about autocompletes in notepad ++ ?

    • Ivan January 19, 2013 at 12:39 am

      Unfortunately, there are no any news about this feature. The priority of this task is not high so I’m afraid it won’t be added in the near future.

  18. cifuentes September 30, 2013 at 7:32 pm

    What about vs2012? is possible to get it to vs2012 working with js files (no aspx with scripts inside) ?

    thanks

    • Stanislav October 2, 2013 at 2:10 pm

      It works the same as for VS2010
      If you need the autocomplete in the standalone js file, you need to add the reference to the dhtmlx.js

      /// <reference path="../some/dhtmlx.js" />
  19. Luca November 6, 2013 at 11:45 am

    Hi Ivan,

    Notepad++ would be greatly appreciated :-)
    you also had a nice link above..

    thanks for any news.

  20. Andi September 2, 2014 at 8:53 am

    what about support for https://atom.io ?

  21. kaigege October 17, 2014 at 10:33 am

    要是能支持sublime text 就好了。

  22. loic October 24, 2014 at 1:16 pm

    Hi,
    I’ve just install the webstorm update (v9) and the autocomplete doesn’t work anymore.
    Is there any dhtmlx3.sdoc.js update ready?
    Thanks,
    Loïc

  23. Gordon Frobenius April 16, 2015 at 12:32 am

    Would LOVE this for Sublime Text! Will you guys look into that please?

  24. SDeaV July 10, 2015 at 10:43 am

    It doesnt work properly in Aptana Studio 3

  25. Alex October 9, 2016 at 9:39 am

    Any plans to add support for Sublime Text please?

    • Aras Kairys (DHTMLX team) October 10, 2016 at 3:52 pm

      Hi Alex,
      Can you please clarify what functionality do you mean under “support for Sublime Text”?

Leave a Reply