PageTemplateInstance Class

Class holding the page template structure information.

Inheritance Hierarchy

System.Object
  CMS.PortalEngine.PageTemplateInstance

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

Syntax

public class PageTemplateInstance : IStructuredData

The PageTemplateInstance type exposes the following members.

Constructors

	Name	Description
Public method	PageTemplateInstance()	Empty constructor
Public method	PageTemplateInstance(String)	Constructor

Fields

	Name	Description
Protected field	mWebPartsXml	Web parts XML.
Protected field	mWebPartZones	Collection of the webpart zones contained within the page template.

Properties

	Name	Description
Public property	ContentPersonalizationVariantsLoaded	Indicates whether Content personalization variants have been loaded for this page template instance.
Public property	MVTVariantsLoaded	Indicates whether MVT variants have been loaded for this page template instance.
Public property	ParentPageTemplate	Parent page template.
Public property	WebParts	Gets or sets the page template WebParts.
Public property	WebPartZones	Web part zones contained within the Page template.

Methods

	Name	Description
Public method	AddWebPart(String, WebPartInstance, Int32)	Adds the web part instance to the specified zone.
Public method	AddWebPart(String, Int32, Int32)	Adds the web part instance to the specified zone
Public method	AddWidget	Adds the widget instance to the specified zone.
Public method	AddZone	Adds the given zone to the template
Public method	Clone	Clones the instance of page templates.
Public method	CloneWebPart	Clones the web part.
Public method	CombineWith(WebPartInstance)	Combines the page template instance with a web part instance, applies the web part instance settings to the current page template instance.
Public method	CombineWith(WebPartZoneInstance)	Combines the page template instance with a web part zone instance, applies the web part zone instance settings to the current page template instance.
Public method	CombineWith(PageTemplateInstance, WidgetZoneTypeEnum, Boolean)	Combines two page template instances, applies the other page template instance settings (only those matching the required zone type in the current instance) to the current instance. Does not add new zones which are not present in the current instance.
Public method	ContainsZones	Returns true if the page template contains zones of the specific type.
Public method	EnsureZone	Ensures that the instance of the given zone exists.
Public method	GetNestedZones	Gets the list of zones nested in the given web part
Public method	GetUniqueWebPartId	Returns unique web part ID within this Page template.
Public method	GetWebPart(Guid, String)	Returns the web part with specified GUID or ID or null if not found.
Public method	GetWebPart(String, Boolean)	Returns the web part with specified ID or null if not found.
Public method	GetWebPart(Guid, Int32, Int32)	Finds the web part by its GUID.
Public method	GetXmlElement(XmlDocument)	Gets the XML element for the data
Public method	GetXmlElement(XmlDocument, WidgetZoneTypeEnum)	Gets the XML element for the data
Public method	GetZone	Returns the zone instance with specified ID or null when not found.
Public method	GetZonesXML	Returns the XML representation of the zones configuration.
Public method	LoadFromXml	Reloads the zones and webparts info.
Public method	LoadFromXmlElement	Loads the data from the given XML element
Public method	LoadVariants	Loads all the MVT/Content personalization variants for this template instance.
Public method	LoadZones	Obsolete. Reloads the zones and webparts info.
Public method	MoveAllWebParts	Moves all web parts from one zone to another
Public method	MoveWebPart	Moves the web part between two zones
Public method	MoveWebPartDown(WebPartInstance, Boolean)	Moves web part down within its zone.
Public method	MoveWebPartDown(String, String, Boolean)	Moves web part down within the instance of the specified zone.
Public method	MoveWebPartToNextZone(WebPartInstance)	Moves the web part to the Next zone.
Public method	MoveWebPartToNextZone(String, String)	Moves the web part to the next zone.
Public method	MoveWebPartToPreviousZone(WebPartInstance)	Moves the web part to the previous zone.
Public method	MoveWebPartToPreviousZone(String, String)	Moves the web part to the previous zone.
Public method	MoveWebPartUp(WebPartInstance, Boolean)	Moves web part up within its zone.
Public method	MoveWebPartUp(String, String, Boolean)	Moves web part up within the instance of the specified zone.
Public method	RemoveZone	Removes zone from template instance
Public method	ZoneExists	Returns true if zone with given ID already exists