Documentation for the outdated version. Latest Aurigma Upload Suite docs

Verifies whether the specified special folder is available.

Syntax

JavaScript

getImageUploader("ImageUploaderID").CanGoToFolder(Folder);

Parameters

Folder
A member of this enumeration that specifies a special folder to check:
String value Description
BitBucket Recycle Bin
Desktop Desktop (for the user currently logged into the system)
MyComputer My Computer
MyDocuments My Documents (for the user currently logged into the system)
MyMusic My Music (for the user currently logged into the system)
MyPictures My Pictures (for the user currently logged into the system)
MyVideo My Video (for the user currently logged into the system)
Network My Network Places
Recent Recent Documents (for the user currently logged into the system)

Return Value

A boolean value (true or false). If the specified folder is available (and Image Uploader can navigate it), the method returns true, otherwise it returns false.

Note

This method works only for special folders. You cannot verify physical path on the local machine with this method.

Remarks

This method is helpful if you use custom buttons to navigate to the special folder (like My Pictures or My Documents). For example you can check what special folders are available and hide buttons for the folders which are not available.

To navigate to a certain special folder, use the GoToFolder() method.