Using CKFinder Plugins

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(Article contents proof-read and formatted)
 
Line 2: Line 2:
  
 
== Enabling ASP.NET Plugins ==
 
== Enabling ASP.NET Plugins ==
 +
To enable an ASP.NET plugin, follow the steps below.
  
==== Step1: Create a reference to .dll file ====
+
==== Step 1: Create a Reference to the .dll File ====
To add a plugin to CKFinder, create a reference to a .dll file with a plugin (for example: CKFinder_ImageResize.dll) in your project:
+
To add a plugin to CKFinder, create a reference to the <code>.dll</code> file containing the plugin (for example: <code>CKFinder_ImageResize.dll</code>) in your project, using one of the following methods:
* manually copy .dll with a plugin (it's in the "ckfinder/plugins/pluginname/bin/Release" directory) to the "bin" directory of your web site
+
* manually copy the <code>.dll</code> file with the plugin (it is located in the <code>ckfinder/plugins/''pluginname''/bin/Release</code> directory) to the <code>bin</code> directory of your website,
* or in your Visual Studio.NET project: right-click "References" in the "Solution Explorer", use "Browse" to select dll file from the directory you have saved it in.
+
* or in your Visual Studio.NET project, right-click '''References''' in the '''Solution Explorer''' section, then use '''Browse''' to select the <code>.dll</code> file from the directory you have saved it in.
  
==== Step2: Enable plugin in config.ascx ====
+
==== Step 2: Enable the Plugin in config.ascx ====
Enable plugin in the configuration file (config.ascx):
+
You should now enable the plugin in the configuration file (<code>config.ascx</code>):
  
 
<source lang="asp">
 
<source lang="asp">
 
Plugins = new string[] {
 
Plugins = new string[] {
"CKFinder.Plugins.ImageResize, CKFinder_ImageResize"
+
"CKFinder.Plugins.ImageResize, CKFinder_ImageResize"
 
};
 
};
 
</source>
 
</source>
  
== Related topics ==
+
== Related Topics ==
 
* [[/Writing_JavaScript|Writing JavaScript plugins]]
 
* [[/Writing_JavaScript|Writing JavaScript plugins]]
 
* [[/Writing_ASP.NET|Writing ASP.NET plugins]]
 
* [[/Writing_ASP.NET|Writing ASP.NET plugins]]

Latest revision as of 13:24, 21 April 2011

CKFinder is a plugin-based application and as such it can be extended relatively easily.

Enabling JavaScript Plugins

To add a plugin to CKFinder, upload it to the plugins folder and enable it by using the extraPlugins configuration option in the config.js file:

CKFinder.customConfig = function( config )
{
	config.extraPlugins = 'dummy';
};

Enabling ASP.NET Plugins

To enable an ASP.NET plugin, follow the steps below.

Step 1: Create a Reference to the .dll File

To add a plugin to CKFinder, create a reference to the .dll file containing the plugin (for example: CKFinder_ImageResize.dll) in your project, using one of the following methods:

  • manually copy the .dll file with the plugin (it is located in the ckfinder/plugins/pluginname/bin/Release directory) to the bin directory of your website,
  • or in your Visual Studio.NET project, right-click References in the Solution Explorer section, then use Browse to select the .dll file from the directory you have saved it in.

Step 2: Enable the Plugin in config.ascx

You should now enable the plugin in the configuration file (config.ascx):

Plugins = new string[] {
	"CKFinder.Plugins.ImageResize, CKFinder_ImageResize"
};

Related Topics

This page was last edited on 21 April 2011, at 13:24.