Integration

Contents

Introduction

Before reading this section, please read the installation and configuration instructions and make sure that the examples located in the _samples directory are working correctly.

The _samples directory contains HTML files with examples of launching CKFinder by using the JavaScript code as well as a aspx folder with examples of launching CKFinder by using the ASP.NET language.

The following files are used when either the JavaScript or the ASP.NET method of launching CKFinder is used:

  • ckfinder.js in case of the JavaScript integration method,
  • ckfinder_v1.js in case of JavaScript V1 integration method (useful when migrating from CKFinder 1.x),

Example

To start CKFinder using the JavaScript integration method, basically we need to do three things:

  • Create an instance of a CKFinder class.
  • Assign CKFinder properties.
  • Call the Create method.

The example of creating CKFinder using a javascript object:

<script type="text/javascript">
var finder = new CKFinder();
finder.basePath = '/ckfinder/';
finder.create();
</script>

The example of creating CKFinder in the ASP.NET page:

<CKFinder:FileBrowser ID="FileBrowser1" BasePath="/ckfinder/" Width="800" runat="server"></CKFinder:FileBrowser>

For a full working examples please refer to the "_samples" directory. Note that in case of javascript integration, it is required to include the integration file (ckfinder.js) to have access to the CKFinder class. In case of ASP.NET integration, you must copy the CKFinder.dll file to your "bin" directory or make a reference to it in your Visual Studio project.

Integration methods

  • JavaScript integration - The preferred method of integration, simple, yet powerful.
  • JavaScript integration (V1) - The old "V1" way, useful when migrating from CKFinder 1.x because it is possible to reuse the old code.
  • ASP.NET integration - If you haven't worked with JavaScript before or the JavaScript integration seems to be too complicated then it might be the way to go for you.
This page was last modified on 18 May 2010, at 12:24.