Click or drag to resize
PageTemplateInstance Class
Class holding the page template structure information.
Inheritance Hierarchy
SystemObject
  CMS.PortalEnginePageTemplateInstance

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class PageTemplateInstance : IStructuredData

The PageTemplateInstance type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldmWebPartsXml
Web parts XML.
Protected fieldmWebPartZones
Collection of the webpart zones contained within the page template.
Top
Properties
  NameDescription
Public propertyContentPersonalizationVariantsLoaded
Indicates whether Content personalization variants have been loaded for this page template instance.
Public propertyMVTVariantsLoaded
Indicates whether MVT variants have been loaded for this page template instance.
Public propertyParentPageTemplate
Parent page template.
Public propertyWebParts
Gets or sets the page template WebParts.
Public propertyWebPartZones
Web part zones contained within the Page template.
Top
Methods
  NameDescription
Public methodAddWebPart(String, WebPartInstance, Int32)
Adds the web part instance to the specified zone.
Public methodAddWebPart(String, Int32, Int32)
Adds the web part instance to the specified zone
Public methodAddWidget
Adds the widget instance to the specified zone.
Public methodAddZone
Adds the given zone to the template
Public methodClone
Clones the instance of page templates.
Public methodCloneWebPart
Clones the web part.
Public methodCombineWith(WebPartInstance)
Combines the page template instance with a web part instance, applies the web part instance settings to the current page template instance.
Public methodCombineWith(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 methodCombineWith(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 methodContainsZones
Returns true if the page template contains zones of the specific type.
Public methodEnsureZone
Ensures that the instance of the given zone exists.
Public methodGetNestedZones
Gets the list of zones nested in the given web part
Public methodGetUniqueWebPartId
Returns unique web part ID within this Page template.
Public methodGetWebPart(Guid, String)
Returns the web part with specified GUID or ID or null if not found.
Public methodGetWebPart(String, Boolean)
Returns the web part with specified ID or null if not found.
Public methodGetWebPart(Guid, Int32, Int32)
Finds the web part by its GUID.
Public methodGetXmlElement(XmlDocument)
Gets the XML element for the data
Public methodGetXmlElement(XmlDocument, WidgetZoneTypeEnum)
Gets the XML element for the data
Public methodGetZone
Returns the zone instance with specified ID or null when not found.
Public methodGetZonesXML
Returns the XML representation of the zones configuration.
Public methodLoadFromXml
Reloads the zones and webparts info.
Public methodLoadFromXmlElement
Loads the data from the given XML element
Public methodLoadVariants
Loads all the MVT/Content personalization variants for this template instance.
Public methodMoveAllWebParts
Moves all web parts from one zone to another
Public methodMoveWebPart
Moves the web part between two zones
Public methodMoveWebPartDown(WebPartInstance, Boolean)
Moves web part down within its zone.
Public methodMoveWebPartDown(String, String, Boolean)
Moves web part down within the instance of the specified zone.
Public methodMoveWebPartToNextZone(WebPartInstance)
Moves the web part to the Next zone.
Public methodMoveWebPartToNextZone(String, String)
Moves the web part to the next zone.
Public methodMoveWebPartToPreviousZone(WebPartInstance)
Moves the web part to the previous zone.
Public methodMoveWebPartToPreviousZone(String, String)
Moves the web part to the previous zone.
Public methodMoveWebPartUp(WebPartInstance, Boolean)
Moves web part up within its zone.
Public methodMoveWebPartUp(String, String, Boolean)
Moves web part up within the instance of the specified zone.
Public methodRemoveZone
Removes zone from template instance
Public methodZoneExists
Returns true if zone with given ID already exists
Top
See Also