Kentico CMS 7.0 Developer's Guide

API examples user interface

API examples user interface

Previous topic Next topic Mail us feedback on this topic!  

API examples user interface

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

If you have Kentico CMS API examples installed, you can access them by:


Going to Site Manager -> Support and choosing API examples from the Support tree.




Switching to the API examples directly by adding CMSAPIExamples to the application URL.




In either case, you will be redirected to the Kentico CMS API Examples user interface. Now choose from the Modules tree the module whose API examples you would like to see. This will display the interface of API examples of the particular module.




The API examples user interface consists of:


Creating and managing section for creating, getting and updating objects,

Cleanup section for deleting objects and their dependencies,

Code area for displaying the examples code.


In this interface, you can run API examples and you can also display the code. This can be done by clicking the View code (Search) icon next to the corresponding example. The code of the example will be displayed in the Code area. Using the following icons, you can show/hide line numbers (Numbers), toggle to the fit-to-window mode (Full_screen) and search through the code (Search_API). Besides, the interface enables you to copy the code to clipboard. However, editing the code directly in the Code area is not allowed.


Source codes of API examples can be found in <web project folder>/CMSAPIExamples/Code.




Please note


The Kentico CMS API Examples user interface does not have multilingual support.