CMS.MediaLibrary

Class encapsulating MediaFile.

Constructor.

MediaFile info Output file data

Ensures that the object contains the output data.

Default data which should be loaded if data required Returns true if new data has been loaded

Loads the data to the object.

Loads the preview data to the object.

Returns value of column.

Column name Returns the value Returns true if the operation was successful (the value was present)

Returns value of column.

Column name

Sets value of column.

Column name Column value

Returns true if the object contains specified column.

Column name

If true, the watermark is allowed to be used.

Media file info object.

Time when the file was last modified.

Indicates if file preview shoul be pused for output file.

Media file site name.

Mime type.

File extension.

File path.

Physical file path to the data.

Gets physical file path to the original file.

Gets or sets the value of the column.

Column name

Column names.

Class for asynchronous folder tasks logging.

Constructor.

Runs the action.

Gets the duplicity key for the worker to eliminate duplicit queued workers.

Site name (optional).

Source folder.

Target folder (optional).

Library ID.

Server ID.

Type of the task.

Class providing basic variables and properties.

Root folder path in file system.

Path to the trees images.

Selected path in treeview.

Expand path in treeview.

Media library folder in root of treeview.

Media library path for root of tree within library.

Gets or sets the file id querystring parameter.

Gets or sets the path querystring parameter.

Gets or sets the filter method.

Indicates if subfolders content should be displayed.

Indicates if file count in directory should be displayed in folder tree.

Current folder in library.

Where condition.

URL provider for the media files.

Returns relative URL path to the media file, user permissions are not checked.

Media file info object Site name Library folder name

Returns relative URL path to the media file, user permissions are not checked.

Site name Library folder name File path within the library folder

Returns relative URL path to the media file which is rewritten to calling GetMediaFile.aspx page where user permissions are checked.

File GUID File name

Returns absolute URL path to the media file including http://, user permissions are not checked

Site name Library folder name File path within the library folder

Returns absolute URL path to the media file including http:// which is rewritten to calling GetMediaFile.aspx page where user permissions are checked

Site name File GUID File name

Returns absolute URL path for current domain to the media file including http:// which is rewritten to calling GetMediaFile.aspx page where user permissions are checked

File GUID File name

Gets media file relative URL for WebDAV.

Library name File path Community group name (optional)

Returns relative URL path to the media file, user permissions are not checked.

Media file info object Site name Library folder name File path within the library folder

Returns relative URL path to the media file which is rewritten to calling GetMediaFile.aspx page where user permissions are checked.

File GUID File name

Returns absolute URL path to the media file including http://, user permissions are not checked

Site name Library folder name File path within the library folder

Returns absolute URL path to the media file including http:// which is rewritten to calling GetMediaFile.aspx page where user permissions are checked

Site name File GUID File name

Returns URL for External storage or null.

Relative path from root. Site name.

Media library data source server control.

OnInit override, register OnFilter change event.

OnFilterChange handler.

Gets data source from DB.

Dataset as object

Gets the default cache dependencies for the data source.

Gets Datasource object.

Gets or sets the group ID.

Indicates if the group libraries should be included. (If no group ID is provided.).

Name of the cache item the control will use.

Media file data source server control.

OnInit override, register OnFilter change event.

OnFilterChange handler.

Gets data source from DB.

Dataset as object

Gets the default cache dependencies for the data source.

Gets or sets the file path.

Gets or sets the allowed file extensions.

Gets or sets the source filter name.

Indicates if the group files should be included.

Gets or set the group id (for permission checking).

Gets or sets if user permissions to file should be checked.

Gets Datasource object.

Name of the cache item the control will use.

Media file info data container class.

Type information.

Checks if the object has unique code name. Returns true if the object has unique code name.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Gets media files physical files.

Operation type If true, gets the binary data to the DataSet

Saves media file physical files.

DataSet with physical files data

Constructor - Creates an empty MediaFileInfo object.

Constructor - Creates a new MediaFileInfo object from the given Data class.

Constructor - Creates a new MediaFileInfo object from the given DataRow.

Constructor - creates a new MediaFileInfo object from posted file.

Posted file ID of the library the file will be assigned to

Constructor - creates a new MediaFileInfo object from posted file.

Posted file ID of the library the file will be assigned to Library subfolder path where file should be saved

Constructor - creates a new MediaFileInfo object from posted file.

Posted file ID of the library the file will be assigned to Library subfolder path where file should be saved Height of the image Max side size of the image Width of the image

Constructor - creates a new MediaFileInfo object from posted file.

Posted file ID of the library the file will be assigned to Library subfolder path where file should be saved Height of the image Max side size of the image Width of the image ID of the site new media file is related to

Constructor - creates a new MediaFileInfo object specified by its file physical path.

File physical path ID of the library the file will be assigned to

Constructor - creates a new MediaFileInfo object specified by its file physical path.

File physical path ID of the library the file will be assigned to Library subfolder path where file should be saved

Constructor - creates a new MediaFileInfo object specified by its file physical path.

File physical path ID of the library the file will be assigned to Library subfolder path where file should be saved Width of the image Height of the image Max side size of the image

Creates a clone of the object

If true, the object is cleared to be able to create new object

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Inserts the file to the database using standard MediaFileInfoProvider.SetMediaFileInfo function.

Clone settings Result Original object

File custom data.

MediaFile binary - for file information transfer purposes, not saved to the database.

MediaFile binary stream - for file information transfer purposes, not saved to the database.

File extension.

File library ID.

File GUID.

Date and time when the file was last modified.

ID of user who last modified current file.

Date ant time when the file was created.

ID of user who created current file.

File ID.

File size.

File site ID.

File image width.

File path.

File name.

File title.

File description.

File mime type.

File image height.

Indicates if the object versioning is supported.

Class providing media file info management.

Thumbnail quality.

Lock object for ensuring of the physical files.

Gets the maximal file size which is allowed for media files staging synchronization.

Gets the maximal file size which is allowed for media files versioning.

Returns data on files matching given criteria from database.

Order by statement to use Where condition used to filter data

Returns dataset of files matching given criteria from database.

WHERE condition ORDER BY parameter TOP N parameter Selected columns

Returns the MediaFileInfo structure for the specified media file.

Media file ID

Returns media file with specified GUID.

Media file GUID Site name

Returns the MediaFileInfo structure for the specified media file.

Media library ID File path

Returns the MediaFileInfo structure for the specified media file.

Site name File path

Returns the MediaFileInfo structure for the specified media file.

Site name File path Library folder name

Sets (updates or inserts) specified media file.

Media file to set

Sets (updates or inserts) specified media file.

Media file to set Indicates if unique file name should be ensured

Sets (updates or inserts) specified media file.

Media file to set ID of the user performing set action Indicates if unique file name should be ensured

Import media file into database.

Media file to import

Import media file into database.

Media file to import ID of the user performing set action

Deletes specified media file.

Media file ID

Deletes specified media file.

Media file object

Deletes media file from filesystem.

Site id Library id Sub path to file Indicates if method is running by web farms synchronization

Deletes media file from filesystem.

Site id Library id Sub path to file Indicates if only file should be deleted Indicates if method is running by web farms synchronization

Deletes media file preview from filesystem.

Site name Library ID File path Indicates if method is running by web farms synchronization

Updates the file path of all the files matching specified criteria.

ID of the library where the files belongs to New file path of the files Old file path of the files

Deletes file records of files matching specified criteria.

Path of the files to delete ID of the library where the files belongs to

Gets the cache key dependencies array for the media file (cache item keys affected when the meta file changes).

File Indicates if preview cache key should be created

Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).

Media file info to check New width New height Max side size

Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).

File path New width New height Max side size

Saves media file to disk and returns the applied file path.

Name of the site of the media library Media library root folder Subfolder path Name of the file Extension of the file File data File GUID Indicates if method is running by web farms synchronization

Saves media file to disk and returns the applied file path.

Name of the site of the media library Media library root folder Subfolder path Name of the file Extension of the file File data File GUID Indicates if method is running by web farms synchronization Indicates if unique file name should be ensured

Saves media file to disk and returns the applied file path.

Copy media file.

Site name Library ID Old file path within the library folder New file path within the library folder Indicates if method is running by web farms synchronization

Copy media file.

Site name Library ID Old file path within the library folder New file path within the library folder Indicates if method is running by web farms synchronization ID of the user performing copy action

Moves media file within one library.

Site name Library ID Old file path within the library folder New file path within the library folder Indicates if method is running by web farms synchronization

Moves media file.

Site name Original library ID New library ID Old file path within the library folder New file path within the library folder Indicates if method is running by web farms synchronization

Returns physical path to the media file.

Media library ID File path

Returns physical path to the media file.

Media file ID Site name Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns physical path to the media file.

Media file info Site name Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns physical path to the given file path and library.

Media file path Library ID of the media file Site name Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns physical path to the media file.

Site name Library folder name File path within the library folder

Returns physical path to the media file.

Site name Library folder name File path within the library folder Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns physical path to the thumbnail.

Site name of the site thumbnail is related to File name of the file thumbnail is related to Extension of the file thumbnail is related to Path of the original file Width of the thumbnail file Height of the thumbnail file Indicates if hidden folder should be inserted into path Indicates if file extension should be inserted into thumbnail file name

Returns physical path to the thumbnail folder.

Site name File path from database Media library ID

Returns physical path to the thumbnail folder.

Site name File path from database Media library ID Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns physical path to the thumbnail folder.

Media libray ID File path from database

Returns preview file path for search pattern (.* as extension).

File path from database Site name Library ID

Returns preview file path for media file info. If no preview found returns NULL

Media file info

Returns relative URL path to the media file, user permissions are not checked.

Site name Library folder name File path within the library folder

Returns relative URL path to the media file which is rewritten to calling GetMediaFile.aspx page where user permissions are checked.

File GUID File name

Returns absolute URL path to the media file including http://, user permissions are not checked

Site name Library folder name File path within the library folder

Returns absolute URL path to the media file including http:// which is rewritten to calling GetMediaFile.aspx page where user permissions are checked

Site name File GUID File name

Returns absolute URL path for current domain to the media file including http:// which is rewritten to calling GetMediaFile.aspx page where user permissions are checked

File GUID File name

Ensures the thumbnail file.

File info Site name File width File height Maximum side size

Ensures the thumbnail file.

File info Site name File width File height Maximum side size Use preview file

Returns image thumbnail from the disk or create a new one if doesn't exist yet.

File info Library folder Site name Image width Image height Maximum side size

Returns the file from disk or (if not available on the disk) from database.

File info Site name Library folder

Returns true if image should be scaled down.

Max side size Width Height Image width Image height

Returns image thumbnail from the disk or create a new one if doesn't exist yet.

Original file path Original width Original height Width Height

Returns physical path to the file.

File name File extension File path

Deletes media file thumbnails.

File info

Deletes media file preview thumbnails.

File info

Returns dataset of files matching given criteria from database.

WHERE condition ORDER BY parameter TOP N parameter Selected columns

Returns the MediaFileInfo structure for the specified media file.

Media file ID

Returns media file with specified GUID.

Media file GUID Site name

Returns the MediaFileInfo structure for the specified media file.

Media library ID File path

Returns the MediaFileInfo structure for the specified media file.

Site name File path Library folder name

Sets MediaFileInfo internal.

Media file info Save file to disk ID of the user performing set action Indicates if unique file name should be ensured

Updates the file path of all the files matching specified criteria.

ID of the library where the files belongs to New file path of the files Old file path of the files

Saves media file to disk and returns the applied file path.

Name of the site of the media library Media library root folder Subfolder path Name of the file Extension of the file Indicates if unique file name should be ensured New file path

Thumbnail quality.

Gets the maximal file size in bytes which is allowed for media files staging synchronization.

Gets the maximal file size in bytes which is allowed for media files versioning.

Media file preview class.

Preview preffix for identification preview file.

Icon set name.

Indicates if active content (video, flash etc.) should be displayed.

Indicates whether the links to media file should be processed in a secure way.

Class providing media library helper methods.

Class providing helper methods for media library.

Return file path with replaced back slash ("\") to slash ("/").

File path

Return file path with replaced slash ("/") to back slash ("\").

File path

Ensures unique path for the specified directory. If the directory with the specified name already exist in the target location new path with the added suffix is returned. The suffix consist of '_' sign and the number.

Directory path to ensure

Ensures unique path for the specified file. If the directory with the specified name already exist in the target location new path with the added suffix is returned. The suffix consist of '_' sign and the number.

Complete path to the file to ensure

Returns media file preview suffix from settings.

Site name

Returns media file hidden folder name from settings.

Site name

Returns root folder from settings where all media libraries are stored.

Site name

Returns true if media library root folder is outside of CMS.

Site name

Returns true if media library root folder is outside of CMS.

Site name. Library folder.

Returns media file preview file name.

File name File extension File preview extension Site name

Returns media file preview file name.

File name File extension File preview extension Site name Preview suffix

Returns media file preview file path.

Media file info

Moves preview file into new location according new media file name.

Media file info New media file path

Returns true if is known audio extension.

File extension

Returns true if is known video extension.

File extension

Returns flash html code.

URL path to swf file Width Height

Returns video html code.

File Url Width Height Extension

Returns audio html code.

File URL Width Height File extension

Returns image html code.

Image url Width Height Max side size Original image width Original image height Image description

Show preview file if exists or file icon.

Media file info Width of preview to display Height of preview to display Max side size of preview to display Media file preview suffix Name of the subfolder where icon images are located Page

Show preview file if exists or file icon.

Media file info Width of preview to display Height of preview to display Max side size of preview to display Media file preview suffix Name of the subfolder where icon images are located Page Default teaser image

Recursive copy media library directory.

Library ID Directory Info Destination path Source DB path Library path index Starting point Indicate if database entries should copy

Recursive copy media library directory.

Library ID Directory Info Destination path Source DB path Library path index Starting point Indicate if database entries should copy ID of the user performing action

Recursive copy media library directory.

Source library ID Destination library ID Directory Info Destination path Source DB path Library path index Starting point Indicate if database entries should copy ID of the user performing action

Recursive copy media library directory.

Source library ID Destination library ID Directory Info Destination path Source DB path Library path index Starting point Indicate if database entries should copy ID of the user performing action Indicates if the destination folder and files can be overwritten MediaLibrary clone settings. Only some parameters are used. If null, cloning is not used and FileMediaInfo is inserted as a directly. Results of cloning will be stored to this instance

Clone media library files and folder to new media library.

Source library ID Destination library ID MediaLibrary clone settings. Only some parameters are used Results of cloning will be stored to this instance

Returns true if file has preview file.

Site name Library ID File path within library

Returns physical path to the directory where all media libraries are stored.

Site name

Returns physical path to the directory where all media libraries are stored.

Site name Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns allowed extensions list from settings.

Name of the site

Determines whether the file with the specified extension (case insensitive) can be uploaded into library module on current site.

File extension to check

Determines whether the file with the specified extension (case insensitive) can be uploaded into library module on site specified by name.

File extension to check File extension to check

Returns the permission matrix for the specified media library.

Library ID Library site ID Library group ID Media library resource ID Array of permissions

Returns access dednied message for specified permission.

Permission name

Returns MediaSource for given media file.

Media file GUID Site name

Returns MediaSource for given media file.

Media file path Site name Library folder name

Returns media file url according to site settings.

Media file guid Site name

Returns MediaSource for given media file.

Media file data

Test if the right exists within the given rights.

Right to check File access rule

Logs the synchronization task for media folder.

Site name Library ID Source path Target path Task type Indicates if the logging should run asynchronously Returns new synchronization task

Logs the synchronization task for media folder.

Site name Library ID Source path Target path Task type Server ID to synchronize Returns new synchronization task

Logs the synchronization task for media folder.

Site name Library ID Source path Target path Task type Server ID to synchronize Indicates if the logging should run asynchronously Returns new synchronization task

Gets media folder empty DataSet.

Gets task title.

Task type Source path Target path Media library

Seffix regex for files and folders.

Custom path to media library.

Class representing media library in the current context.

Private constructor.

Returns information on the current media library according the library ID/ library GUID/ library name specified as an URL parameter of the current request

Returns information on the current media file according the fileid or fileguid specified as an URL parameter of the current request

Registers the properties of this object

Context object.

Current media library info object matching libraryid, libraryguid or libraryname specified in the URL parameter of the current request

Current media file info object matching fileid or fileguid specified in the URL parameter of the current request.

Media library info data container class.

Type information.

Type information for group library.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Inserts cloned object to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Clones the role bindings.

Cloning settings Result of the cloning - messages in this object will be altered by processing this method Original source BaseInfo (object being cloned)

Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called (Modify => Manage).

Permission to convert to string

Constructor - Creates an empty MediaLibraryInfo object.

Constructor - Creates a new MediaLibraryInfo object from the given DataRow.

Media library full name in format [sitename].[libraryname].

Library group ID.

Library description.

Library site ID.

Library folder.

Library name.

Library display name.

Library GUID.

Library ID.

Library access.

Library last modified.

Indicates whether the file creating is allowed.

Indicates whether the file deleting is allowed.

Indicates whether the file modifying is allowed.

Indicates whether the folder creating is allowed.

Indicates whether the folder deleting is allowed.

Indicates whether the folder modifying is allowed.

Indicates whether the access to library is allowed.

Library teaser path.

Library teaser guid.

Type information.

Class providing media library info management.

Current media library.

Hashtable indexed by LibraryID.

Hashtable indexed by full library name in format [SiteName].[LibraryName].

Indicates if media files physical files should be deleted.

Table lock for loading.

Gets hashtable key.

Library name Library site ID Library group ID

Load libraries data into hashtables.

Clears the hashtables.

If true, web farm tasks are logged

Returns the MediaLibraryInfo structure for the specified media library.

MediaLibrary id

Rerurns media library info specified by library name, site ID and group ID directly from DB.

Library name Library Site ID Library Group ID

Rerurns media library info specified by library name and site name directly from DB.

Library name Site name

Returns information on libraries matching specified criteria.

Where condition to filter data Order by statement to use

Returns information on libraries matching specified criteria.

Where condition to filter data Order by statement to use Top N records List of columns to be returned

Returns media library info specified by library name and site name. Do not use for retrieving group MLs (use GetMediaLibraryInfo(string libraryName, int siteId, int groupId) instead).

Library name Site name

Returns media library info specified by library name, site name and groupId.

Library name Site ID Group ID

Returns the MediaLibraryInfo structure for the specified media library.

MediaLibrary id

Sets (updates or inserts) specified media library.

MediaLibrary to set

Deletes specified media library.

MediaLibrary object

Deletes specified media library.

Media library id

Delete media libraries only from database for selected group.

Group ID

Add security where condition to the existing where condition.

Existing where condition Community group ID Returns where condition

Removes library dependencies.

MediaLibrary object

Returns True if current user is granted with specified media library permission, otherwise returns False.

Media library data Permission code name

Returns True if current user is granted with specified media library permission, otherwise returns False.

Media library data Permission code name User to check

Checks the specified permission for resource (cms.groups if library group id is specified, cms.medialibrary otherwise).

ID of the library group Name of the permission User info to check Site name

Checks specified media library permission.

Media library ID Media library group ID Name of the permission which is checked Value of the permission User info to check

Returns true if the user is authorized per given library.

Library ID Permission name User ID

Returns physical path to the specified library folder.

Site name Library folder name

Returns physical path to the specified library.

Library ID

Returns physical path to the specified library.

Library ID Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns physical path to the specified library.

Library ID Site name Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Gets the folder path for the given media library

Media library info

Gets the folder path for the given media library

Media library info Site name Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Returns physical path to the specified library folder.

Site name Library folder name Physical path to the root of the web project (e.g. c:\WebProject\), if it is not specified web application physical path is used

Delete folder from media library.

Site name Media library ID Path to the folder within the library Indicates if method is running by web farms synchronization

Delete folder from media library.

Site name Media library ID Path to the folder within the library Indicates if method is running by web farms synchronization Indicates if staging task should be logged

Delete media library root folder from media root directory. ~/[site name]/media/

Site name Media library folder Indicates if method is running by web farms synchronization

Delete media library root folder from media root directory. ~/[site name]/media/

Site name Media library folder Indicates if method is running by web farms synchronization Indicates if staging task should be logged

Delete all media libraries folders.

Site name List of folder to delete

Creates folder within specified library.

Site name Library ID New folder path Indicates if method is running by web farms synchronization

Creates folder within specified library.

Site name Library ID New folder path Indicates if method is running by web farms synchronization Indicates if staging task should be logged

Rename folder within specified library.

Site name Library ID Original folder path New folder path Indicates if method is running by web farms synchronization

Rename folder within specified library.

Site name Library ID Original folder path New folder path Indicates if method is running by web farms synchronization Indicates if staging task should be logged

Copy media library folder.

Site name Library ID Old folder path within the library folder New folder path within the library folder Indicates if method is running by web farms synchronization

Copy media library folder.

Site name Library ID Old folder path within the library folder New folder path within the library folder Indicates if method is running by web farms synchronization ID of the user performing the action

Copy media library folder.

Site name Library ID Old folder path within the library folder New folder path within the library folder Indicates if method is running by web farms synchronization Indicates if staging task should be logged

Copy media library folder.

Moves media library folder.

Site name Library ID Old folder path within the library folder New folder path within the library folder Indicates if method is running by web farms synchronization

Moves media library folder.

Indicates if media files physical files should be deleted.

Media library object types.

Code name for media library.

Code name for group media library.

Code name for media file.

Code name for abstract media folder.

Code name for library role permission.

Media library role permission data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty MediaLibraryRolePermission object.

Constructor - Creates a new MediaLibraryRolePermission object from the given DataRow.

Library ID.

Role ID.

Permission ID.

Class providing media library role permission management.

Returns the media library role permission data matching specified criteria.

Where condition used to filter the data Order by statement to use

Returns the media library role permission structure matching specified criteria.

ID of the library ID of the role ID of the permission

Sets (updates or inserts) specified library role permission.

Library role permission to set

Deletes specified media library role permission.

Media library role permission object

Adds specified role to the library.

Role ID Library ID Permission ID

Deletes specified library role.

Role ID Library ID Permission ID

Delete all media library roles.

Where condition

Sets permissions for list of roles.

Media library ID List of role IDs separated by semicolon List of permisson IDs separated by semicolon

Module registration.

Constructor.

Module info

Registers the object type of this module

Get media file path

Parameters array

Get media file path

Parameters array

Get media file path

Parameters array

Get media thumbnails path

Parameters array

Get media file object

Parameters array

Get media library object

Parameters array

Get media file url

Parameters array

Gets the media file URL

Parameters array

Gets the media source

Parameters array

Delete media libraries only from database which belong to the specified group

Parameters array

Delete media libraries folders from media root folder (~/[site name]/media/)

Parameters array

Delete media file

Parameters array

Delete media file preview

Parameters array

Get whether physical files should be deleted

Parameters array

Set if physical files should be deleted

Parameters array

Gets media root folder path

Parameters array

Gets media libraries for given site

Parameters array

Gets media libraries for given site and group

Parameters array

Create media library folder

Parameters array

Copy media library folder

Parameters array

Move media library folder

Parameters array

Rename media library folder

Parameters array

Delete media library folder

Parameters array

Delete media library root folder

Parameters array

Save file to disk

Parameters array

Copy media file

Parameters array

Move media file

Parameters array

Registers the contexts of this module

Clears the module hashtables.

If true, web farm tasks are logged