PageTemplateInfoProvider Class

Provides access to information about page templates.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<PageTemplateInfo, PageTemplateInfoProvider, ObjectQuery<PageTemplateInfo>>
    CMS.DataEngine.AbstractInfoProvider<PageTemplateInfo, PageTemplateInfoProvider>
      CMS.PortalEngine.PageTemplateInfoProvider

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 11.0.0

Syntax

public class PageTemplateInfoProvider : AbstractInfoProvider<PageTemplateInfo, PageTemplateInfoProvider>

The PageTemplateInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	PageTemplateInfoProvider	Constructor.

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public field Static member	WEBPART_TEMPLATE_STARTID	ID from which start the virtual page templates for web parts

Properties

	Name	Description
Public property Static member	AdhocTemplateLayoutsDirectory	Gets the ad-hoc template layouts directory.
Public property Static member	ClonePageTemplateInfo	If true, page info which is retrieved by the methods is a clone of the original page info object.
Public property Static member	CreateSearchTasks	Gets or sets the value that indicates whether search tasks should be created if template was changed.
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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 Static member	StorePageTemplatesInExternalStorage	Gets or sets the value that indicates whether page template/device layouts should be stored externally
Public property Static member	TemplateLayoutsDirectory	Gets the template layouts directory.
Public property Static member	TemplatesDirectory	Gets the template layouts directory.
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Public method Static member	AddPageTemplateToSite	Adds page template to specific site.
Public method	AddSiteWhereCondition	Obsolete. Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	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	CloneTemplateAsAdHoc	Gets new page template object cloned as an ad-hoc template from the given source page template info.
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 Static member	DeleteAdHocTemplates	Deletes all ad hoc templates for given node (UI element) based on it's GUID.
Protected method	DeleteAdHocTemplatesInternal	Deletes all ad hoc templates for given node (UI element) based on it's GUID.
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeletePageTemplate(Int32)	Deletes page template with specific ID.
Public method Static member	DeletePageTemplate(PageTemplateInfo)	Deletes page template.
Public method Static member	GetAdhocPageLayoutName	Gets full ad-hoc layout name from the given virtual layout path.
Public method Static member	GetAllowedTemplates	Gets page templates allowed for specified site.
Public method Static member	GetAllowedTemplatesInCategory	Gets page templates allowed for specified site.
Protected method	GetAllowedTemplatesInCategoryInternal	Gets page templates allowed for specified site.
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	GetFullPhysicalPath(PageTemplateInfo)	Gets full path of the page template.
Public method Static member	GetFullPhysicalPath(PageTemplateInfo, String)	Gets full path of the page template.
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	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	GetInfoById	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>.)
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	GetPageLayoutName	Gets full layout name from the given virtual layout path.
Public method Static member	GetPageTemplateInfo(Int32)	Gets the page template object.
Public method Static member	GetPageTemplateInfo(String)	Gets the page template object.
Public method Static member	GetPageTemplateInfo(String, Int32)	Gets the page template object.
Public method Static member	GetPageTemplateTypeCode	Gets the page template type code for the given enum value.
Public method Static member	GetPageTemplateTypeEnum	Gets the page template type enumeration for the given string value.
Protected method	GetSingleObject	Obsolete. Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition	Obsolete. Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetTemplates	Get all page templates using ObjectQuery.
Public method Static member	GetTemplatesInCategory	Gets all templates in specified category.
Public method Static member	GetVirtualObject	Returns web part layout info for specified path
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>.)
Public method Static member	IsPageTemplateOnSite	Checks if exists relation between page template and site.
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	PageTemplateNameExists(String)	Checks whether the page template with given name already exists.
Public method Static member	PageTemplateNameExists(String, Int32)	Checks whether the page template with given name already exists.
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	RemovePageTemplateFromSite	Removes page template from site.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (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	SetPageTemplateInfo	Sets the specified page template.
Public method	SortAlphabetically	Obsolete. Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)
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>.)