Wiktor: Created page with '== 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…'

2010-05-14T19:10:47Z

Created page with '== 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…'

New page

== 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.
* '''[[CKFinder_2.x/SelectFunction|SelectFunction]]''' - An optional function to be called when the user selects a file in CKFinder.
* '''[[CKFinder_2.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_2.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_2.x/SelectThumbnailFunction#SelectThumbnailFunctionData|SelectThumbnailFunctionData]]''' - An optional argument of type string that will be passed to the "SelectThumbnailFunction".
* '''[[CKFinder_2.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").
* '''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 "{{ #ifeq: {{{language}}} | aspnet | CKFinderId | Id }}" property (explained below). Default value: true.
* '''{{ #ifeq: {{{language}}} | aspnet | CKFinderId | Id }}''' - Used to identify the CKFinder object, optional. If set, the "{{ #ifeq: {{{language}}} | aspnet | CKFinderId | Id }}" variable will be passed to the server connector on each request. When "RememberLastFolder" is enabled and the "{{ #ifeq: {{{language}}} | aspnet | CKFinderId | 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".

Template:CKFinder 2.x Integration Properties - Revision history

Wiktor: Created page with '== 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…'