CKEditor for ASP.NET Control Integration Guide

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.

(CKEditor.NET -> CKEditor for ASP.NET)
(added info about BasePath)
 
Line 14: Line 14:
 
# Insert a CKEditor instance into the page body:
 
# Insert a CKEditor instance into the page body:
 
#: <source>
 
#: <source>
<CKEditor:CKEditorControl ID="CKEditor1" runat="server"></CKEditor:CKEditorControl>
+
<CKEditor:CKEditorControl ID="CKEditor1" BasePath="/ckeditor/" runat="server"></CKEditor:CKEditorControl>
 
</source>
 
</source>
 +
#: (where <code>BasePath</code> points to the directory with CKEditor)
  
 
A sample page of your project containing CKEditor might look like the one below. When you run the application in the browser, you will be able to use all features of the editor.
 
A sample page of your project containing CKEditor might look like the one below. When you run the application in the browser, you will be able to use all features of the editor.
  
 
[[Image:CKENET_VS_project.png|thumbnail|center|750px|Sample Visual Studio project containing CKEditor]]
 
[[Image:CKENET_VS_project.png|thumbnail|center|750px|Sample Visual Studio project containing CKEditor]]

Latest revision as of 17:02, 21 June 2012

These integration instructions are written with more advanced ASP.NET developers in mind and describe the basic steps required to run the CKEditor for ASP.NET control. If you are not sure about the whole process, please refer to the Absolute Beginner's CKEditor for ASP.NET Control Integration Guide with a detailed description of the process along with some screenshots.

If you want to integrate CKEditor with your ASP.NET page, follow the steps outlined below.

  1. Go to the official CKEditor download site and download the latest versions of both CKEditor 3.x and the CKEditor for ASP.NET control.
  2. Unpack both installation packages to a desired location.
  3. Add a reference to the CKEditor for ASP.NET Control to your website.
    In Visual Studio use the Add Reference command and browse to bin\Release\CKEditor.NET.dll file from the unpacked CKEditor for ASP.NET installation package. You can also manually copy the DLL file to the bin folder of your application.
  4. Copy the unpacked editor files from the CKEditor 3.x installation package and paste them into the application directory of your website.
  5. Register the CKEditor for ASP.NET control in your page:
    <%@ Register Assembly="CKEditor.NET" Namespace="CKEditor.NET" TagPrefix="CKEditor" %>
  6. Insert a CKEditor instance into the page body:
    <CKEditor:CKEditorControl ID="CKEditor1" BasePath="/ckeditor/" runat="server"></CKEditor:CKEditorControl>
    (where BasePath points to the directory with CKEditor)

A sample page of your project containing CKEditor might look like the one below. When you run the application in the browser, you will be able to use all features of the editor.

Sample Visual Studio project containing CKEditor
This page was last edited on 21 June 2012, at 17:02.