Click or drag to resize
TransformationInfoProvider Class
Enables access to Transformations.
Inheritance Hierarchy
System.Object
  CMS.DataEngine.AbstractInfoProvider<TransformationInfo, TransformationInfoProvider, ObjectQuery<TransformationInfo>>
    CMS.DataEngine.AbstractInfoProvider<TransformationInfo, TransformationInfoProvider>
      CMS.DocumentEngine.TransformationInfoProvider

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131
Syntax
C#
public class TransformationInfoProvider : AbstractInfoProvider<TransformationInfo, TransformationInfoProvider>, 
	IFullNameInfoProvider

The TransformationInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodTransformationInfoProvider
Initializes a TransformationInfoProvider.
Top
Fields
Properties
  NameDescription
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public propertyStatic memberDefaultDirectives
Default transformation directives made into an array.
Public propertyStatic memberDefaultNamespaces
List of default transformation namespaces
Public propertyStatic memberEditButtonsRegex
Gets the Regex object for edit/delete buttons macro
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public propertyStatic memberInternalTransformationDirectives
Internal transformation directives.
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public propertyStatic memberStoreTransformationsInExternalStorage
Gets or sets the value that indicates whether transformations should be stored externally
Public propertyStatic memberTransformationBaseClass
Gets or sets the transformation base class
Public propertyStatic memberTransformationDirectives
Transformation directives.
Public propertyStatic memberTransformationsDirectory
TransformationsDirectory - Read only
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodBulkInsertInfos(IEnumerable<BaseInfo>)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodBulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodCheckUniqueValues
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 methodClearHashtables
Clears the object's hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodCreateWebFarmTask(String, String,Byte[], String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodDelete
Deletes the info object from the underlying data store.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberDeleteTransformation(Int32)
Deletes the transformation.
Public methodStatic memberDeleteTransformation(TransformationInfo)
Deletes the transformation.
Public methodStatic memberDeleteTransformations
Deletes all the transformations of the specified class.
Public methodStatic memberGenerateTransformationCode
Generates the default transformation code for given class.
Public methodGet()
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGetAsync(Guid, Nullable<CancellationToken>)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGetAsync(Int32, Nullable<CancellationToken>)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGetAsync(String, Nullable<CancellationToken>)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGetAsync(Guid, Int32, Nullable<CancellationToken>)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodGetAsync(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 methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodGetFullNameDictionary
Creates a new dictionary for caching the transformations by the full name.
Public methodGetFullNameWhereCondition
Gets the where condition that searches the transformation based on the given full name.
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberGetLocalizedTransformation
Gets the localized transformation by full name. Returns the default transformation if the localized version is not found.
Public methodStatic memberGetNamespaceRegistration
Gets the registration tag for the given namespace and assembly.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodStatic memberGetTransformation(Int32)
Gets the transformation by ID.
Public methodStatic memberGetTransformation(String)
Gets the transformation by full name.
Public methodStatic memberGetTransformationFullName
Returns full transformation name by provided transformation ID.
Protected methodGetTransformationInfoInternal
Gets the transformation by full name.
Public methodStatic memberGetTransformations()
Returns all transformations.
Public methodStatic memberGetTransformations(Int32)
Gets the transformations of the specified class.
Public methodStatic memberGetVirtualObject
Returns web part layout info for specified path
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodStatic memberRemoveDirectives
Removes the transformation directives.
Public methodStatic memberRemoveFirstPart
Returns the string with first selector removed.
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public methodSet
Inserts or updates the info object in the underlying data store.
(Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public methodSetAsDefaultProvider

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 methodSetInfo
Inserts or Updates the object to the database.
(Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
Public methodStatic memberSetTransformation
Saves the specified transformation to the database.
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodUpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected methodUpdateObjectInHashtables
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 methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Top
See Also