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

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

The PageTemplateInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodPageTemplateInfoProvider
Constructor.
Top
Fields
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.
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Methods
  NameDescription
Public methodStatic memberAddPageTemplateToSite
Adds page template to specific site.
Public methodAddSiteWhereCondition Obsolete.
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, 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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clears the object's hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberCloneTemplateAsAdHoc
Gets new page template object cloned as an ad-hoc template from the given source page template info.
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 methodDeleteInfo
Deletes the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteInfo(TInfo).)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeletePageTemplate(Int32)
Deletes page template with specific ID.
Public methodStatic memberDeletePageTemplate(PageTemplateInfo)
Deletes page template.
Public methodStatic memberGetAdhocPageLayoutName
Gets full ad-hoc layout name from the given virtual layout path.
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.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetFullPhysicalPath(PageTemplateInfo)
Gets full path of the page template.
Public methodStatic memberGetFullPhysicalPath(PageTemplateInfo, String)
Gets full path of the page template.
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.
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.
Protected methodGetSingleObject Obsolete.
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetSiteWhereCondition Obsolete.
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetTemplates
Get all page templates using ObjectQuery.
Public methodStatic memberGetTemplatesInCategory
Gets all templates in specified category.
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberIsPageTemplateOnSite
Checks if exists relation between page template and site.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberRemovePageTemplateFromSite
Removes page template from site.
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQuerySetInfo(TInfo).)
Public methodStatic memberSetPageTemplateInfo
Sets the specified page template.
Public methodSortAlphabetically Obsolete.
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, 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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also