AttachmentBinaryHelper Class

Helper for getting and managing attachment binary data

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<AttachmentBinaryHelper>
        CMS.DocumentEngine.AttachmentBinaryHelper

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

public class AttachmentBinaryHelper : AbstractHelper<AttachmentBinaryHelper>

The AttachmentBinaryHelper type exposes the following members.

Constructors

	Name	Description
Public method	AttachmentBinaryHelper

Properties

	Name	Description
Public property Static member	DeletePhysicalFiles	Thumbnail quality.
Public property Static member	ThumbnailQuality	Thumbnail quality.

Methods

	Name	Description
Protected method	CanResizeImageInternal	Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).
Public method Static member	DeleteFile	Delete all files with the same name ([name].*) in specified directory.
Protected method	DeleteFileInternal	Delete all files with the same name ([name].*) in specified directory.
Public method Static member	EnsurePhysicalFile	Ensures the file in the file system and returns the path to the file.
Protected method	EnsurePhysicalFileInternal	Ensures the file in the file system and returns the path to the file.
Protected method	EnsureThumbnailFileInternal	Ensures the thumbnail file.
Public method Static member	GetAttachmentBinary	Returns the file from disk or (if not available on the disk) from database.
Protected method	GetAttachmentBinaryInternal(DocumentAttachment)	Returns the file from disk or (if not available on the disk) from database.
Protected method	GetAttachmentBinaryInternal(Guid, String)	Returns the file from disk or (if not available on the disk) from database.
Protected method	GetAttachmentBinaryInternal(Guid, Int32, String, Boolean)	Returns attachment binary and optionally store it in file system.
Public method Static member	GetFilePhysicalPath	Returns physical path to the file.
Protected method	GetFilePhysicalPathInternal	Returns physical path to the file.
Public method Static member	GetFilesFolderPath	Returns files folder physical path according to 'CMSFilesFolder' settings key is set or not.
Protected method	GetFilesFolderPathInternal	Returns files folder physical path according to 'CMSFilesFolder' settings key is set or not.
Protected method	GetFilesFolderRelativePathInternal	Returns files folder relative path according to 'CMSFilesFolder' settings key is set or not.
Protected method	GetImageThumbnailBinaryFileInternal	Returns the image thumbnail from the disk.
Protected method	GetImageThumbnailInternal(DocumentAttachment, Int32, Int32, Int32, Boolean)	Returns image thumbnail (from the disk - if already exists, or create new one and save it to disk - if doesn't exist).
Protected method	GetImageThumbnailInternal(Guid, Byte[], String, String, Int32, Int32, Int32, Int32, Int32)	Returns image thumbnail (from the disk - if already exists, or create new one and save it to disk - if doesn't exist).
Protected method	GetThumbnailPhysicalPathInternal	Returns physical path to the thumbnail.
Protected method	ResizeImageAttachmentInternal	Resizes image to specified dimensions.
Protected method	SaveFileToDiskInternal	Saves file to the disk.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)