Files Pane

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.

(Advanced Operations: Deleting a file in CKFinder added)
(Viewing (Previewing) a File: Updated to CKFinder 2.2)
 
Line 89: Line 89:
 
In order to preview a file in the browser, choose the <strong>View</strong> option from its context menu. Not all kinds of files can be viewed in browsers, but this feature is quite useful for images, text, and PDF files. In other cases, the browser will ask you to open the file with an appropriate application.
 
In order to preview a file in the browser, choose the <strong>View</strong> option from its context menu. Not all kinds of files can be viewed in browsers, but this feature is quite useful for images, text, and PDF files. In other cases, the browser will ask you to open the file with an appropriate application.
  
Depending on your browser and operating system settings, the file will be displayed in a new browser tab or a new browser window.
+
When you attempt to preview an image, CKFinder will display in directly in a lightbox popup.
  
 
=== Downloading a File ===
 
=== Downloading a File ===

Latest revision as of 13:51, 30 March 2012

The Files Pane lists all files available in the selected folder.

CKFinder Files Pane


Different Views

The Files Pane may present the files with two different display formats, depending on CKFinder settings (see "Settings"). The following is a comparison of the Thumbnails and the List views for the same folder.

When you configure CKFinder to use the Thumbnails view, the files will be presented as thumbnails (miniature previews or icons), with or without additional information like file name, size, or date (depending on your settings).

CKFinder Files Pane with Thumbnails view


When you configure CKFinder to use the List view, the files will be presented in a list, with or without additional information like file name, size, or date (depending on your settings).

CKFinder Files Pane with List view


Basic Operations

Activating (Selecting) a File with a Mouse

In order to activate a file and make it the "current file" in CKFinder, click the file name or its thumbnail. To make it easier to choose the file, when you hover your mouse over a file, its background will become highlighted. Once a file is activated, it will be permanently highlighted with a different background color.

The figure below presents various states of a file as viewed in a folder: unselected, hovered with a mouse, and activated (selected).

CKFinder file select unselected.png CKFinder file select hovered.png CKFinder file select selected.png

In order to deactivate a file, click another one (activating it) or click any empty space inside the Files Pane.

Copying Files

In order to copy a file to a different folder, select it, and drag onto the target folder in the Folders Pane. When you drop it onto a folder name, choose the Copy File Here option from the context menu.

Copying a file in CKFinder


The file will be duplicated and its copy will be placed in the target folder. The source folder will remain untouched.

File copied in CKFinder


important note
Note: If the file with the same name already exists in the target folder, you will be prompted to choose between overwriting it or automatically renaming the copied file (this is the default option).


Error message for a file that already exists in CKFinder


Moving Files

In order to move a file to a different folder, select it, and drag onto the target folder in the Folders Pane. When you drop it onto a folder name, choose the Move File Here option from the context menu.

Moving a file in CKFinder


The file will be removed from the source folder and pasted into the target folder.

File moved in CKFinder


Advanced Operations

Advanced operations can be performed on a file by using its Context Menu. Depending on the circumstances, the following options may be available:

File context menu in CKFinder


  • Select – selects the file.
  • View – displays the full-sized file in a new browser tab or window.
  • Download – downloads the file from the server to your computer.
  • Resize – allows you to modify file size and/or create a new thumbnail.
  • Rename – changes the name of the file.
  • Delete – permanently removes the file.
important note

Note: Some context menu options may be disabled (and thus grayed out), depending on CKFinder settings enforced by your system administrator.


Selecting a File

In order to select a file by using the context menu, choose the Select option. Alternatively, you can also perform a double-click on the file with your mouse.

Depending on the environment where CKFinder is used, the selection operation can, for example, send the file URL to another application or insert an image directly into an article created in your CMS system.

Viewing (Previewing) a File

In order to preview a file in the browser, choose the View option from its context menu. Not all kinds of files can be viewed in browsers, but this feature is quite useful for images, text, and PDF files. In other cases, the browser will ask you to open the file with an appropriate application.

When you attempt to preview an image, CKFinder will display in directly in a lightbox popup.

Downloading a File

In order to download a file, choose the Download option from its context menu. The browser will ask you for a location on your computer to save the downloaded file. Depending on your browser and operating system settings, the file might also be opened immediately after it is downloaded by using an appropriate application of your operating system.

Resizing a File (Image)

In order to change the image size or its thumbnail size, choose the Resize option from its context menu. Once you enter new image dimensions or choose a thumbnail size, close the dialog window to apply the changes.

Resizing an image in CKFinder


If the image is too big, you can alter its dimensions by entering new values into the Width and Height fields. By default the image ratio is locked, which you can see thanks to the CKEditor lock.png (Lock) button. This means that when you change one of the size values (width or height), the other one will be adjusted automatically.

If you want to freely modify both dimensions, click the Lock button in order to unlock the ratio. The button will now change to CKEditor unlock.png (Unlock) and modification of one dimension will not automatically cause the other one to be adjusted. To lock the image ratio again, click the Unlock button once more.

You can easily return to original image size by pressing the CKEditor reset size.png (Reset Size) button. This will reset the image size; the original width and height will now appear in appropriate text boxes.

If you resize the image, you can decide to save it under the same name, overwriting the existing file. Please note that this operation cannot be undone and once you save the file with its modified dimensions, you will not be able to restore the original size. In order to overwrite the original image, leave the Create a new image checkbox unselected.

Overwriting a resized image in CKFinder


You can also decide to save the resized image in a new file and leave the original as is. If you select the Create a new image checkbox, you will be able to give the modified file a new name. By default CKFinder suggests to save the image under the name that is built from the original file name and new file dimensions (for example: Sun1_100x100.jpg when the original file was named Sun1.jpg and the file was resized to 100 pixels wide and 100 pixels high).

Creating a new resized image in CKFinder


When you are ready with your changes, click the OK button to close the dialog window. On successful resizing a confirmation message will be displayed.

File resized in CKFinder


If you saved the resized image in a new file, you will see both files appear inside the folder.

Original and resized file in CKFinder


important note

Note: The size of the original image may limit the options available for the Resize feature. The modified image size cannot exceed the original dimensions.


Generating Thumbnails

The Resize feature can also be used in order to generate resized copies of images (thumbnails) that you can use in articles on your website or in blog posts. Thanks to the thumbnail resizing feature the site administrator can set predefined thumbnail size options that can be used by CKFinder users. This will save you the effort to manually enter modified width and height values for each image and will let you keep the thumbnail sizes consistent across your site.

In order to use one of the predefined thumbnail sizes, choose the Resize option from the image context menu. In the Create a new thumbnail section of the Resize dialog window select the checkbox(es) representing the desired thumbnail size(s). On successful resizing a confirmation message will be displayed. The resized image copies will be created in the same folder and the new files will be named according to the thumbnail size option that you choose (with _large, _medium and _small suffixes added to the original file name).

Thumbnails generated in CKFinder


important note

Note: If the image is smaller than some of the thumbnails options (see example above), the ones that are unavailable will be grayed out.


Renaming a File

In order to rename a file, choose the Rename option from its context menu or use the F2 keyboard shortcut. Type the new file name in the dialog window that will be displayed, overwriting the existing name. Once you enter the new file name and close the dialog window, the file will be renamed.

Renaming a file in CKFinder


Not all characters can be used in folder and file names due to limitations of the systems where CKFinder runs. Among the characters that cannot be used in folders and files names are: \ / : * ? " < > and |.

important note
Attention: When you rename a file, links or media insertions available on other pages and pointing to the renamed file will be broken, and thus not available anymore. Because of that be careful when using this feature.


Deleting a File

In order to delete a file, choose the Delete option from its context menu or use the Del key. A confirmation message will appear to ensure that this operation is what you really intend to do. Once you confirm the deletion, the file will be removed.

important note

Attention: This operation cannot be undone. Once you delete the file, you will not be able to restore it.


Deleting a file in CKFinder


important note
Attention: When you delete a file, links or media insertions available on other pages and pointing to the deleted file will be broken, and thus not available anymore. Because of that be careful when using this feature.
This page was last edited on 30 March 2012, at 13:51.