Click or drag to resize
MediaLibraryHelper Class
Class providing helper methods for media library.
Inheritance Hierarchy
SystemObject
  CMS.MediaLibraryMediaLibraryHelper

Namespace: CMS.MediaLibrary
Assembly: CMS.MediaLibrary (in CMS.MediaLibrary.dll) Version: 13.0.131
Syntax
C#
public class MediaLibraryHelper

The MediaLibraryHelper type exposes the following members.

Constructors
  NameDescription
Public methodMediaLibraryHelper
Top
Fields
  NameDescription
Public fieldStatic memberOBJECT_TYPE_FOLDER
Object type for abstract media folder.
Public fieldStatic memberURL_PARAMETER_USE_THUMBNAIL_FOR_NON_RESIZABLE_IMAGE
This parameter is added to the url to retrieve thumbnail of non-editable image for which we cannot get dimensions (e.g. webp or svg files).
Top
Properties
  NameDescription
Public propertyStatic memberMediaLibraryCustomPath
Custom path to media library.
Public propertyStatic memberSuffixRegex
Suffix regex for files and folders.
Top
Methods
  NameDescription
Public methodStatic memberCloneLibraryFiles
Clone media library files and folder to new media library.
Public methodStatic memberCopyRecursive(Int32, DirectoryInfo, String, String, Int32, String, Boolean, Int32)
Recursive copy media library directory.
Public methodStatic memberCopyRecursive(Int32, Int32, DirectoryInfo, String, String, Int32, String, Boolean, Int32, Boolean, CloneSettings, CloneResult)
Recursive copy media library directory.
Public methodStatic memberEnsurePhysicalPath
Returns file path with slashes by DirectorySeparatorChar.
Public methodStatic memberEnsureUniqueDirectory
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.
Public methodStatic memberEnsureUniqueFileName
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.
Public methodStatic memberGetAccessDeniedMessage
Returns access denied message for specified permission.
Public methodStatic memberGetAllowedExtensions
Returns allowed extensions list from settings.
Public methodStatic memberGetDirectUrl
Returns a direct URL to the media file.
Public methodStatic memberGetMediaFileHiddenFolder
Returns media file hidden folder name from settings.
Public methodStatic memberGetMediaFilePreviewSuffix
Returns media file preview suffix from settings.
Public methodStatic memberGetMediaLibrariesFolder
Returns root folder from settings where all media libraries are stored.
Public methodStatic memberGetMediaRootFolderPath
Returns physical path to the directory where all media libraries are stored.
Public methodStatic memberGetPermanentUrl
Returns a permanent URL to the media file.
Public methodStatic memberGetPreviewFileName
Returns media file preview file name.
Public methodStatic memberGetPreviewFilePath
Returns media file preview file path.
Public methodStatic memberGetTaskTitle
Gets task title.
Public methodStatic memberHasPreview
Returns true if file has preview file.
Public methodStatic memberIsExtensionAllowed
Determines whether the file with the specified extension (case insensitive) can be uploaded into library module on site specified by name.
Public methodStatic memberIsExternalLibrary
Returns true if media library root folder is outside of CMS.
Public methodStatic memberLogSynchronization(String, Int32, String, String, TaskTypeEnum, Boolean)
Logs the synchronization task for media folder.
Public methodStatic memberLogSynchronization(String, Int32, String, String, TaskTypeEnum, Int32)
Logs the synchronization task for media folder.
Public methodStatic memberLogSynchronization(String, Int32, String, String, TaskTypeEnum, Int32, Boolean)
Logs the synchronization task for media folder.
Public methodStatic memberMoveMediaFilePreview
Moves preview file into new location according new media file name.
Public methodStatic memberUseMediaLibrariesSiteFolder
Gets the value that indicates if site-specific folder should be used for media files physical files.
Top
See Also