WebPartZoneInstance Class

Web part zone instance. Keeps configuration data for parent web part.

Inheritance Hierarchy

System.Object
  CMS.PortalEngine.WebPartZoneInstance

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

Syntax

public class WebPartZoneInstance

The WebPartZoneInstance type exposes the following members.

Constructors

	Name	Description
Public method	WebPartZoneInstance()	Constructor.
Public method	WebPartZoneInstance(XmlNode)	Constructor.

Methods

	Name	Description
Public method	AddWebPart(Int32, Int32)	Adds a web part instance of a specified type to the webparts.
Public method	AddWebPart(WebPartInstance, Int32)	Add the web part to the zone. If the web part is present in different zone, creates a copy of the web part.
Public method	ClearValues	Clears the given properties
Public method	Clone	Returns the cloned zone instance object.
Public method	CloneWebPart	Clones the web part.
Public method	EnsureWebPartInstanceIdentificators	Ensures web part ControlID and instance GUID for current zone
Public method Static member	GetUniqueWebPartId	Returns unique web part ID within the given Page template.
Public method	GetValue	Returns the value of the given webpart property property.
Public method	GetWebPart(Guid)	Returns the web part instance with specified GUID or null when not found.
Public method	GetWebPart(String, Boolean)	Returns the web part instance with specified ID or null when not found.
Public method	GetXmlNode	Returns the Xml node representing the zone configuration.
Public method	LoadVariants	Loads all the MVT/Content personalization variants for this zone instance.
Public method	RemoveAllWebParts	Removes all web parts from the schema.
Public method	RemoveWebPart	Removes the web part instance from the schema.
Public method	SetValue	Sets the property value of the control.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	HasVariants	Indicates whether the web part zone has any variants.
Public property	InstanceGUID	Instance GUID to identify the web part.
Public property	IsVariant	Indicates if webpart instance is a variant of the original web part
Public property	LayoutZone	If true, the zone is generated by layout.
Public property	MacroTable	Hashtable with IsMacro flags.
Public property	ParentTemplateInstance	Parent PageTemplate instance for the zone.
Public property	Properties	Web part properties table.
Public property	VariantID	Gets or sets the variant id.
Public property	VariantMode	Gets the variant mode which is used for the variants of this web part instance.
Public property	WebParts	Web parts collection within the zone.
Public property	WebPartsContainVariants	Indicates whether any of the zone web parts contains variants.
Public property	WidgetZoneType	Widget zone type.
Public property	XMLVersion	Gets or sets the zone instance XML version
Public property	ZoneID	Web part zone ID.
Public property	ZoneInstanceVariants	Gets the zone instance variant list.