Difference between revisions of "Template:Integration Properties"

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.

(Added ResourceType description)
(→‎Properties)
 
Line 7: Line 7:
 
* '''Width''' - The CKFinder width (for example: 600, '80%'). Default value: "100%".
 
* '''Width''' - The CKFinder width (for example: 600, '80%'). Default value: "100%".
 
* '''Height''' - The CKFinder height (for example: 500, '100%'). Default value: 400.
 
* '''Height''' - The CKFinder height (for example: 500, '100%'). Default value: 400.
−
* '''[[CKFinder/SelectFunction|SelectFunction]]''' - An optional function to be called when the user selects a file in CKFinder.
+
* '''[[CKFinder_1.x/SelectFunction|SelectFunction]]''' - An optional function to be called when the user selects a file in CKFinder.
−
* '''[[CKFinder/SelectFunction#SelectFunctionData|SelectFunctionData]]''' - An optional argument of type string that will be passed to the "SelectFunction". Please refer to the js/popups.html file for a usage example.
+
* '''[[CKFinder_1.x/SelectFunction#SelectFunctionData|SelectFunctionData]]''' - An optional argument of type string that will be passed to the "SelectFunction". Please refer to the js/popups.html file for a usage example.
−
* '''[[CKFinder/SelectThumbnailFunction|SelectThumbnailFunction]]''' - An optional function to be called when the user selects a thumbnail in CKFinder. Default value: "SelectFunction" (if "SelectFunction" is set).
+
* '''[[CKFinder_1.x/SelectThumbnailFunction|SelectThumbnailFunction]]''' - An optional function to be called when the user selects a thumbnail in CKFinder. Default value: "SelectFunction" (if "SelectFunction" is set).
−
* '''[[CKFinder/SelectThumbnailFunction#SelectThumbnailFunctionData|SelectThumbnailFunctionData]]''' - An optional argument of type string that will be passed to the "SelectThumbnailFunction".
+
* '''[[CKFinder_1.x/SelectThumbnailFunction#SelectThumbnailFunctionData|SelectThumbnailFunctionData]]''' - An optional argument of type string that will be passed to the "SelectThumbnailFunction".
−
* '''[[CKFinder/SelectThumbnailFunction#DisableThumbnailSelection|DisableThumbnailSelection]]''' - If set to true, "Select thumbnail" item will not appear in the context menu. Default value: false.
+
* '''[[CKFinder_1.x/SelectThumbnailFunction#DisableThumbnailSelection|DisableThumbnailSelection]]''' - If set to true, "Select thumbnail" item will not appear in the context menu. Default value: false.
 
* '''ResourceType''' - Resource type to display. By default CKFinder displays all available resource types. If ResourceType property is set, CKFinder will display only specified resource type (e.g. "Files", "Images").
 
* '''ResourceType''' - Resource type to display. By default CKFinder displays all available resource types. If ResourceType property is set, CKFinder will display only specified resource type (e.g. "Files", "Images").
 
* '''StartupPath''' - Resource Type and the name of the startup folder, separated with a colon (for example: "Files:/", "Images:/cars/"). If defined, CKFinder will open the selected folder automatically.
 
* '''StartupPath''' - Resource Type and the name of the startup folder, separated with a colon (for example: "Files:/", "Images:/cars/"). If defined, CKFinder will open the selected folder automatically.

Latest revision as of 08:27, 28 May 2010

Properties

To use CKFinder, both integration methods can be used. Regardless of chosen method, the following properties are available in the CKFinder object in both cases:

  • BasePath - The URL path for the installation folder of CKFinder. Default value: "/ckfinder/".
  • Width - The CKFinder width (for example: 600, '80%'). Default value: "100%".
  • Height - The CKFinder height (for example: 500, '100%'). Default value: 400.
  • SelectFunction - An optional function to be called when the user selects a file in CKFinder.
  • SelectFunctionData - An optional argument of type string that will be passed to the "SelectFunction". Please refer to the js/popups.html file for a usage example.
  • SelectThumbnailFunction - An optional function to be called when the user selects a thumbnail in CKFinder. Default value: "SelectFunction" (if "SelectFunction" is set).
  • SelectThumbnailFunctionData - An optional argument of type string that will be passed to the "SelectThumbnailFunction".
  • DisableThumbnailSelection - If set to true, "Select thumbnail" item will not appear in the context menu. Default value: false.
  • ResourceType - Resource type to display. By default CKFinder displays all available resource types. If ResourceType property is set, CKFinder will display only specified resource type (e.g. "Files", "Images").
  • StartupPath - Resource Type and the name of the startup folder, separated with a colon (for example: "Files:/", "Images:/cars/"). If defined, CKFinder will open the selected folder automatically.
  • StartupFolderExpanded - Used only when "StartupPath" is set. If set to true, the initial folder will be opened automatically on startup.
  • RememberLastFolder - If set to true, CKFinder will remember the last used folder in a cookie. In some cases, it may be required to store the name of last used folder in separate cookies for different CKFinder instances, in such case, assign the "Id" property (explained below). Default value: true.
  • Id - Used to identify the CKFinder object, optional. If set, the "Id" variable will be passed to the server connector on each request. When "RememberLastFolder" is enabled and the "Id" is set, CKFinder will remember the last directory in a separate cookie.
  • ClassName - The name of the CSS class rule assigned to the CKFinder frame. Default value: "CKFinderFrame".
Retrieved from "https://docs-old.ckeditor.com/index.php?title=Template:Integration_Properties&oldid=3683"
This page was last edited on 28 May 2010, at 08:27.