JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.2.2
[ckeditor.git] / _samples / asp / index.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
2 <!--\r
3 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
4 For licensing, see LICENSE.html or http://ckeditor.com/license\r
5 -->\r
6 <html xmlns="http://www.w3.org/1999/xhtml">\r
7 <head>\r
8         <title>ASP integration Samples List - CKEditor</title>\r
9         <link type="text/css" rel="stylesheet" href="../sample.css" />\r
10 </head>\r
11 <body>\r
12         <h1>\r
13                 CKEditor Samples List for ASP\r
14         </h1>\r
15         <h2>\r
16                 Overview\r
17         </h2>\r
18         <p>The ckeditor.asp file provides a wrapper to ease the work of creating CKEditor instances from classic Asp.</p>\r
19         <p>To use it, you must first include it into your page:\r
20         <code>\r
21                 &lt;!-- #INCLUDE file="../../ckeditor.asp" --&gt;\r
22         </code>\r
23         Of course, you should adjust the path to make it point to the correct location, and maybe use a full path (with virtual="" instead of file="")\r
24         </p>\r
25         <p>After that script is included, you can use it in different ways, based on the following pattern:</p>\r
26 \r
27 <ol>\r
28         <li>\r
29                 Create an instance of the CKEditor class:\r
30 <pre>dim editor\r
31 set editor = New CKEditor</pre>\r
32         </li>\r
33         <li>\r
34                 Set the path to the folder where CKEditor has been installed, by default it will use /ckeditor/\r
35                 <pre>editor.basePath = "../../"</pre>\r
36         </li>\r
37         <li>\r
38         Now use one of the three main methods to create the CKEditor instances:\r
39         <ul>\r
40                 <li>\r
41                                 Replace textarea with id (or name) "editor1".\r
42                         <pre>editor.replaceInstance "editor1"</pre>\r
43                 </li>\r
44                 <li>\r
45                         Replace all textareas with CKEditor.\r
46                         <pre>editor.replaceAll empty</pre>\r
47                 </li>\r
48                 <li>\r
49                         Create a textarea element and attach CKEditor to it.\r
50                         <pre>editor.editor "editor1", initialValue</pre>\r
51                 </li>\r
52         </ul>\r
53         </li>\r
54 </ol>\r
55 <p>Before step 3 you can use a number of methods and properties to adjust the behavior of this class and the CKEditor instances\r
56 that will be created:</p>\r
57 <ul>\r
58         <li>returnOutput : if set to true, the functions won't dump the code with response.write, but instead they will return it so\r
59         you can do anything you want</li>\r
60         <li>basePath: location of the CKEditor scripts</li>\r
61         <li>initialized: if you set it to true, it means that you have already included the CKEditor.js file into the page and it\r
62                 doesn't have to be generated again.</li>\r
63         <li>textareaAttributes: You can set here a Dictionary object with the attributes that you want to output in the call to the "editor" method.</li>\r
64 \r
65         <li>config: Allows to set config values for all the instances from now on.</li>\r
66         <li>instanceConfig: Allows to set config values just for the next instance.</li>\r
67 \r
68         <li>addEventHandler: Adds an event handler for all the instances from now on.</li>\r
69         <li>addInstanceEventHandler: Adds an event handler just for the next instance.</li>\r
70         <li>addGlobalEventHandler: Adds an event handler for the global CKEDITOR object.</li>\r
71 \r
72         <li>clearEventHandlers: Removes one or all the event handlers from all the instances from now on.</li>\r
73         <li>clearInstanceEventHandlers: Removes one or all the event handlers  from the next instance.</li>\r
74         <li>clearGlobalEventHandlers: Removes one or all the event handlers  from the global CKEDITOR object.</li>\r
75 \r
76 </ul>\r
77 \r
78         <h2>\r
79                 Basic Samples\r
80         </h2>\r
81         <ul>\r
82                 <li><a href="replace.asp">Replace existing textareas by code</a></li>\r
83                 <li><a href="replaceAll.asp">Replace all textareas by code</a></li>\r
84                 <li><a href="standalone.asp">Create instances in asp</a></li>\r
85         </ul>\r
86         <h2>\r
87                 Advanced Samples\r
88         </h2>\r
89         <ul>\r
90                 <li><a href="advanced.asp">Advanced example</a></li>\r
91                 <li><a href="events.asp">Listening to events</a></li>\r
92         </ul>\r
93         <div id="footer">\r
94                 <hr />\r
95                 <p>\r
96                         CKEditor - The text editor for Internet - <a href="http://ckeditor.com/">http://ckeditor.com</a>\r
97                 </p>\r
98                 <p id="copy">\r
99                         Copyright &copy; 2003-2010, <a href="http://cksource.com/">CKSource</a> - Frederico Knabben. All rights reserved.\r
100                 </p>\r
101         </div>\r
102 </body>\r
103 </html>\r