WebPartInstance Class

Web part instance representation.

Inheritance Hierarchy

System.Object
  CMS.PortalEngine.WebPartInstance

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

Syntax

public class WebPartInstance : ISimpleDataContainer

The WebPartInstance type exposes the following members.

Constructors

	Name	Description
Public method	WebPartInstance()	Constructor.
Public method	WebPartInstance(XmlNode)	Constructor, initializes the instance with given XML data.

Methods

	Name	Description
Public method	ClearValues	Clears the given properties
Public method	Clone	Clones the web part object (GUID stays the same when cloned).
Public method	FindVariant	Finds the variant with the given variant ID
Public method	GetValue	Returns the value of the given webpart property property.
Public method	GetXmlNode	Returns the XML node representing the webpart instance.
Public method	LoadProperties(DataRow)	Loads default values from specified DataRow to the webpart properties.
Public method	LoadProperties(WebPartInstance)	Loads the webpart properties from given webpart.
Public method	LoadVariants	Loads all the MVT/Content personalization variants for this web part instance.
Public method	ResolvePropertyMacros	Resolves the property macros, replaces the {%propertyname%} macro with the property value.
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	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
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.)

Fields

	Name	Description
Public field Static member	DATASOURCE	Represents nested data source web part name

Properties

	Name	Description
Public property	ControlID	WebPart control ID.
Public property	CurrentVariantInstance	Gets or sets the current variant webpart instance
Public property	HasVariants	Indicates whether the web part has any variants.
Public property	InstanceGUID	Instance GUID to identify the web part.
Public property	IsVariant	Indicates if webpart instance is a variant.
Public property	IsWidget	Indicates if webpart instance is actually widget.
Public property	Item	Gets or sets the value of the property.
Public property	MacroTable	Hashtable with IsMacro flags.
Public property	Minimized	If true, the widget is minimized.
Public property	NestedWebParts	Configuration for the web part data source
Public property	ParentZone	Parent web part zone.
Public property	PartInstanceVariants	Gets the part instance variant list.
Public property	Properties	Web part properties table.
Public property	Removed	Remove flag. If true, web part has been removed. Only for internal purposes.
Public property	VariantID	Gets or sets the variant id.
Public property	VariantMode	Gets or sets the variant mode which is used for the variants of this web part instance.
Public property	WebPartType	WebPart type (codename).
Public property	XMLVersion	Gets or sets the web part instance XML version