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

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

The MediaLibraryHelper type exposes the following members.

Constructors
  NameDescription
Public methodMediaLibraryHelper
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) Obsolete.
Recursive copy media library directory.
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
Return file path with replaced slash ("/") to back slash ("\").
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 memberGetMediaFileHiddenFolder
Returns media file hidden folder name from settings.
Public methodStatic memberGetMediaFilePreviewSuffix
Returns media file preview suffix from settings.
Public methodStatic memberGetMediaFileUrl
Returns media file URL according to site 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 memberGetMediaSource(Guid, String)
Returns MediaSource for given media file.
Public methodStatic memberGetMediaSource(String, String, String)
Returns MediaSource for given media file.
Public methodStatic memberGetPermissionMatrix Obsolete.
Returns the permission matrix for the specified media library.
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(String) Obsolete.
Returns true if media library root folder is outside of CMS.
Public methodStatic memberIsExternalLibrary(String, String)
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 memberShowPreviewOrIcon
Show preview file if exists or file icon.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberOBJECT_TYPE_FOLDER
Object type for abstract media folder.
Top
Properties
  NameDescription
Public propertyStatic memberMediaLibraryCustomPath
Custom path to media library.
Public propertyStatic memberSuffixRegex
Suffix regex for files and folders.
Top
See Also