Kentico CMS 6.0 Context Help

API examples

API examples

Previous topic Next topic Mail us feedback on this topic!  

API examples

Previous topic Next topic JavaScript is required for the print function  

On the left you can see the API examples tree. However, the main portion of the page contains the API examples user interface of the selected tree item.

 

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, as described in more detail in the API examples chapter in the API programming and Kentico CMS internals section of the Developer's Guide, and 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.