MetaFileInfoProvider Class

Class providing MetaFileInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<MetaFileInfo, MetaFileInfoProvider, ObjectQuery<MetaFileInfo>>
    CMS.DataEngine.AbstractInfoProvider<MetaFileInfo, MetaFileInfoProvider>
      CMS.DataEngine.MetaFileInfoProvider

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

Syntax

public class MetaFileInfoProvider : AbstractInfoProvider<MetaFileInfo, MetaFileInfoProvider>, 
	IMetaFileInfoProvider, IInfoProvider<MetaFileInfo>, IInfoByIdProvider<MetaFileInfo>

The MetaFileInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	MetaFileInfoProvider

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	DeletePhysicalFiles	Indicates if physical files should be deleted.
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	WebApplicationPhysicalPath	Full path to the root of the web.

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CanResizeImage	Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CopyMetaFiles(Int32, Int32, String, String, List<Guid>)	Duplicates metafiles for specified object. Returns old guid/new guid list.
Public method Static member	CopyMetaFiles(Int32, Int32, String, String, String, String, List<Guid>)	Duplicates metafiles for specified object. Returns old guid/new guid list.
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	DeleteFile	Delete all files with the same name ([name].*).
Public method Static member	DeleteFiles(GeneralizedInfo, String)	Deletes all files associated to the given object.
Public method Static member	DeleteFiles(Int32, String, String)	Deletes all files associated with the given object.
Protected method	DeleteFilesInternal(GeneralizedInfo, String)	Deletes all files associated to the given object.
Protected method	DeleteFilesInternal(Int32, String, String)	Delete all files associated to the given object.
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteMetaFileInfo(Int32)	Obsolete. Deletes specified metaFile.
Public method Static member	DeleteMetaFileInfo(MetaFileInfo)	Obsolete. Deletes specified metaFile.
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	EnsureMetaFileBinaries	Ensures the binary data in the DataTable of metafiles.
Public method Static member	EnsurePhysicalFile	Ensures the file in the file system and returns the path to the file.
Public method Static member	EnsureThumbnailFile	Ensures the thumbnail file.
Public method Static member	GenerateThumbnails	Returns the current settings whether the thumbnails should be generated.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetFile(Guid, String)	Returns the file from disk or (if not available on the disk) from database.
Public method Static member	GetFile(MetaFileInfo, String)	Returns the file from disk or (if not available on the disk) from database.
Public method Static member	GetFileBinary	Returns the file binary from disk.
Public method Static member	GetFilePhysicalPath	Returns physical path to the file.
Public method Static member	GetFilesFolderPath	Returns physical path to folder with meta files which are associated with the specified site.
Public method Static member	GetFullFileName	Returns full file name ([name.extension] if extension is specified) or ([name] only if extension is not specified).
Public method Static member	GetGUIDWhereCondition	Gets the meta file where condition.
Public method Static member	GetImageThumbnail(MetaFileInfo, String, Int32, Int32, Int32)	Returns image thumbnail (from the disk - if already exists, or create new one and save it to disk - if doesnt exist).
Public method Static member	GetImageThumbnail(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 doesnt exist).
Public method Static member	GetImageThumbnailFile	Returns the image thumbnail from the disk.
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetMetaFileInfo(Int32)	Obsolete. Returns the MetaFileInfo structure for the specified metaFile.
Public method Static member	GetMetaFileInfo(Guid, String, Boolean)	Returns the MetaFileInfo structure for the specified metaFile.
Protected method	GetMetaFileInfoInternal	Returns the MetaFileInfo structure for the specified metaFile.
Public method Static member	GetMetaFileInfoWithoutBinary	Returns the MetaFileInfo structure for the specified metaFile without the binary data.
Public method Static member	GetMetaFiles()	Obsolete. Returns all metafiles.
Public method Static member	GetMetaFiles(Int32, String)	Will call the previous method will all the remaining parameters null.
Public method Static member	GetMetaFiles(String, String, String, Int32)	Gets all the files with specified where/order by.
Public method Static member	GetMetaFiles(Int32, String, String, String, String)	Gets the file list of the files for certain object.
Public method Static member	GetMetaFiles(Int32, String, String, String, String, String, Int32)	Gets the file list of the files for certain object.
Public method Static member	GetMetaFiles(String, String, String, Int32, Int32, Int32, Int32)	Gets all the files with specified where/order by.
Public method Static member	GetMetaFiles(Int32, String, String, String, String, String, Int32, Int32, Int32, Int32)	Gets the file list of the files for certain object.
Protected method	GetMetaFilesInternal()	Returns all metafiles.
Protected method	GetMetaFilesInternal(String, String, String, Int32, Int32, Int32, Int32)
Public method Static member	GetMetaFilesWithBinary	Gets the file list of the files for certain object with the binary file data. Loads the binaries from file system if the binary is missing.
Public method Static member	GetMetaFilesWithoutBinary	Gets the file list of the files for certain object without the binary file data.
Protected method	GetMetaFilesWithoutBinaryInternal	Gets the file list of the files for certain object without the binary file data.
Public method Static member	GetMetaFileUrl	Returns meta file url.
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetThumbnailPhysicalPath	Returns physical path to the thumbnail.
Public method Static member	GetWhereCondition	Gets the where condition for meta files.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	MoveMetaFiles	Moves metafiles for one object to another.
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	ResizeMetaFiles	Resizes specified metafiles to the required dimensions.
Protected method Static member	SaveFileToDisk(String, String, String, String, BinaryData, Boolean)	Save file to the disk.
Public method Static member	SaveFileToDisk(String, String, String, String, BinaryData, Boolean, Boolean)	Saves file to the disk.
Public method	Set	Inserts or updates the info object in the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
Public method Static member	SetMetaFileInfo	Obsolete. Sets (updates or inserts) specified metaFile.
Public method Static member	SetMetaFilesQuality	Changes images quality using GDI+ built in JPEG encoder.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	UpdateMetaFiles	Updates the object meta files from the given DataTable. Returns true if some metafiles were updated.
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)