Click or drag to resize
PageTemplateInfoProvider Class
Provides access to information about page templates.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractProvider
    CMS.DataEngineBaseAbstractInfoProvider
      CMS.DataEngineAbstractInfoProviderPageTemplateInfoProvider
        CMS.DataEngineAbstractInfoProviderPageTemplateInfo, PageTemplateInfoProvider
          CMS.PortalEnginePageTemplateInfoProvider

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 8.2.23
Syntax
C#
public class PageTemplateInfoProvider : AbstractInfoProvider<PageTemplateInfo, PageTemplateInfoProvider>

The PageTemplateInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodPageTemplateInfoProvider
Constructor.
Top
Methods
  NameDescription
Public methodStatic memberAddPageTemplateToSite
Adds page template to specific site.
Public methodAddSiteWhereCondition(String, Int32, String, Boolean)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodAddSiteWhereCondition(String, Int32, String, Boolean, String)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoByGuid(Guid)
Gets the info object by its GUID
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoByGuid(Guid, Int32)
Gets the info object by its GUID and site ID
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoById
Gets the info by ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoByName(String)
Gets the info object by its code name
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfoByName(String, Int32)
Gets the info object by its code name and site Id
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodBoundGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberClear
Clears the hashtables.
Protected methodClearHashtables
Clear hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberCloneTemplateAsAdHoc
Gets new page template object cloned as an ad-hoc template from the given source page template info.
Protected methodCreateHashtables
Creates the provider hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodCreateInfo(Int32)
Creates an instance of info object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodCreateInfo(DataRow, Boolean)
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodCreateWebFarmTask(String, String, Byte)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Public methodStatic memberDeleteAdHocTemplates
Deletes all ad hoc templates for given node(ui element) based on it's GUID
Protected methodDeleteAdHocTemplatesInternal
Deletes all ad hoc templates for given node(ui element) based on it's GUID
Protected methodDeleteData(String)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteData(IWhereCondition)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteData(ActionObjectQueryTInfo)
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberDeletePageTemplate(Int32)
Deletes page template with specific ID.
Public methodStatic memberDeletePageTemplate(PageTemplateInfo)
Deletes page template.
Protected methodDeletePageTemplateInfoInternal
Deletes specified page template.
Public methodStatic memberGetAdhocPageLayoutName
Gets full ad-hoc layout name from the given virtual layout path.
Public methodStatic memberGetAllMasterTemplates
Gets all page templates that are marked as master page.
Public methodStatic memberGetAllowedTemplates
Gets page templates allowed for specified site.
Public methodStatic memberGetAllowedTemplatesInCategory
Gets page templates allowed for specified site.
Protected methodGetAllowedTemplatesInCategoryInternal
Gets page templates allowed for specified site.
Public methodGetBindingWhereCondition(String, Int32)
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetBindingWhereCondition(String, Object)
Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetCacheDependency(DataSet, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetCacheDependency(BaseInfo, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetCountInternal
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByColumnT
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByGuidColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByIntColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDataByStringColumn
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDependencyCacheKeys(DataSet, String, String)
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDependencyCacheKeys(GeneralizedInfo, String, String)
Gets the cache dependency keys for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetEmptyDataSet
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetExistingIDsInternal
Filters out all object IDs that do not exist in the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetFullPhysicalPath(PageTemplateInfo)
Gets full path of the page template.
Public methodStatic memberGetFullPhysicalPath(PageTemplateInfo, String)
Gets full path of the page template.
Protected methodGetInfo(IWhereCondition)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfo(ActionObjectQueryTInfo)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfo(String, String)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Int32)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByCodeNameFromDB
Gets an instance of info object based on the given code name from database
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByFullName(String)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByFullName(String, Boolean)
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByFullNameInternal
Gets the info by its full name from the database
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid, Int32)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuidColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByGuidFromDB
Gets an instance of info object based on the given GUID from database
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoById(Int32)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoById(Int32, Boolean)
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByIntColumn
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfoByStringColumn
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetPageLayoutName
Gets full layout name from the given virtual layout path.
Public methodStatic memberGetPageTemplateInfo(Int32)
Gets the page template object.
Public methodStatic memberGetPageTemplateInfo(String)
Gets the page template object.
Public methodStatic memberGetPageTemplateInfo(String, Int32)
Gets the page template object.
Protected methodGetPageTemplateInfoInternal(Int32)
Gets the page template object for the specified page template ID.
Protected methodGetPageTemplateInfoInternal(String, Int32)
Gets the page template object for the specified page template name.
Public methodStatic memberGetPageTemplateTypeCode
Gets the page template type code for the given enum value.
Public methodStatic memberGetPageTemplateTypeEnum
Gets the page template type enumeration for the given string value.
Public methodGetParentWhereCondition
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetSingleObject
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetSiteWhereCondition(Int32)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetSiteWhereCondition(Int32, Boolean)
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetTemplates
Get all page templates using ObjectQuery.
Public methodStatic memberGetTemplatesInCategory
Gets all templates in specified category.
Protected methodGetTemplatesInternal
Get all page templates using ObjectQuery.
Protected methodGetTypeInfo
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberGetVirtualObject
Returns web part layout info for specified path
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
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 AbstractInfoProviderTInfo, TProvider.)
Protected methodInit
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInitHashtables
Initializes the hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodInvalidate
Sets this provider as invalid
(Inherited from AbstractProvider.)
Public methodStatic memberIsPageTemplateOnSite
Checks if exists relation between page template and site.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodLoadGeneration
Loads the specified generation of the objects.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodLoadObjectsToHashtables
Loads the objects from a DataSet to the hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodNewTransaction
Creates a new transaction over this provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberPageTemplateNameExists(String)
Checks whether the page template with given name already exists.
Public methodStatic memberPageTemplateNameExists(String, Int32)
Checks whether the page template with given name already exists.
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.)
Protected methodRecalculateData
Recalculates the value in the given column using the coefficient.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodRefreshObjectsCounts
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.)
Protected methodRegister
Registers current provider in providers collection
(Inherited from AbstractProvider.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberRemovePageTemplateFromSite
Removes page template from site.
Protected methodReplaceData
Replaces the data in the given columns.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodResetToDefault
Resets the provider to default implementation
(Inherited from AbstractInfoProviderTProvider.)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTProvider.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberSetPageTemplateInfo
Sets the specified page template.
Protected methodSetPageTemplateInfoInternal
Sets (updates or inserts) specified page template.
Public methodSortAlphabetically
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodTouchCacheDependencies
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodUpdateData
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodUseSource(TInfo)
Sets the provider to use given data as data source
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodUseSource(DataQuerySource)
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
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
Protected fieldhashtableLock
Table lock for loading hashtables
(Inherited from BaseAbstractInfoProvider.)
Protected fieldinfos
Info tables.
(Inherited from BaseAbstractInfoProvider.)
Protected fieldmTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Public fieldStatic memberWEBPART_TEMPLATE_STARTID
ID from which start the virtual page templates for web parts
Top
Properties
  NameDescription
Public propertyStatic memberAdhocTemplateLayoutsDirectory
Gets the ad-hoc template layouts directory.
Public propertyStatic memberClonePageTemplateInfo
If true, page info which is retrieved by the methods is a clone of the original page info object.
Public propertyStatic memberCreateSearchTasks
Gets or sets the value that indicates whether search tasks should be created if template was changed.
Protected propertyDataSource
Data source for the provider
(Inherited from BaseAbstractInfoProvider.)
Protected propertyGenerationColumn Obsolete.
Column used to filter the data according the generation in which the items should be loaded.
(Inherited from BaseAbstractInfoProvider.)
Public propertyHashtableSettings
Hashtable settings
(Inherited from BaseAbstractInfoProvider.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public propertyInfoType
Returns the type of the info object for this provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public propertyIsDataAvailable
Returns true if the data is available for this provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractProvider.)
Protected propertyLoadHashtables Obsolete.
Determines the mode in which the hashtables should be loaded. In case the hashtables are loaded through generations, you must also specify the GenerationColumn property.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyProviderName
Provider name
(Inherited from BaseAbstractInfoProvider.)
Public propertyStoreEmptyValuesInHashtables
If true, provider hashtables store empty values for not found objects to reduce database calls
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public propertyStatic memberStorePageTemplatesInExternalStorage
Gets or sets the value that indicates whether page template/device layouts should be stored externally
Public propertyStatic memberTemplateLayoutsDirectory
Gets the template layouts directory.
Public propertyStatic memberTemplatesDirectory
Gets the template layouts directory.
Public propertyTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseFullNameHashtable Obsolete.
If true, the full name hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseGUIDHashtable Obsolete.
If true, the guid hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseHashtables Obsolete.
If true, the provider uses hashtables.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseIDHashtable Obsolete.
If true, the ID hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseNameHashtable Obsolete.
If true, the code name hashtable is allowed to be used.
(Inherited from BaseAbstractInfoProvider.)
Protected propertyUseWeakReferences Obsolete.
If true, the weak references are used for the items so the memory can be cleared upon request
(Inherited from BaseAbstractInfoProvider.)
Top
See Also