Click or drag to resize
WebPartInstance Class
Web part instance representation.
Inheritance Hierarchy
SystemObject
  CMS.PortalEngineWebPartInstance

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 8.2.23
Syntax
C#
public class WebPartInstance : ISimpleDataContainer

The WebPartInstance type exposes the following members.

Constructors
  NameDescription
Public methodWebPartInstance
Constructor.
Public methodWebPartInstance(XmlNode)
Constructor, initializes the instance with given XML data.
Top
Methods
  NameDescription
Public methodClearValues
Clears the given properties
Public methodClone
Clones the web part object (GUID stays the same when cloned).
Public methodFindVariant
Finds the variant with the given variant ID
Public methodGetValue
Returns the value of the given webpart property property.
Public methodGetXmlNode
Returns the XML node representing the webpart instance.
Public methodLoadProperties(DataRow)
Loads default values from specified DataRow to the webpart properties.
Public methodLoadProperties(WebPartInstance)
Loads the webpart properties from given webpart.
Public methodLoadVariants
Loads all the MVT/Content personalization variants for this web part instance.
Public methodResolvePropertyMacros
Resolves the property macros, replaces the {%propertyname%} macro with the property value.
Public methodSetValue
Sets the property value of the control.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberDATASOURCE
Represents nested data source web part name
Top
Properties
  NameDescription
Public propertyControlID
WebPart control ID.
Public propertyCurrentVariantInstance
Gets or sets the current variant webpart instance
Public propertyHasVariants
Indicates whether the web part has any variants.
Public propertyInstanceGUID
Instance GUID to identify the web part.
Public propertyIsVariant
Indicates if webpart instance is a variant.
Public propertyIsWidget
Indicates if webpart instance is actually widget.
Public propertyItem
Gets or sets the value of the property.
Public propertyMacroTable
Hashtable with IsMacro flags.
Public propertyMinimized
If true, the widget is minimized.
Public propertyNestedWebParts
Configuration for the web part data source
Public propertyParentZone
Parent web part zone.
Public propertyPartInstanceVariants
Gets the part instance variant list.
Public propertyProperties
Web part properties table.
Public propertyRemoved
Remove flag. If true, web part has been removed. Only for internal purposes.
Public propertyVariantID
Gets or sets the variant id.
Public propertyVariantMode
Gets or sets the variant mode which is used for the variants of this web part instance.
Public propertyWebPartType
WebPart type (codename).
Public propertyXMLVersion
Gets or sets the web part instance XML version
Top
See Also