Click or drag to resize
CMSAbstractWebPart Class
Base class for the web part controls.
Base class for the web part controls.
Inheritance Hierarchy

Namespace: CMS.PortalControls
Assembly: CMS.PortalControls (in CMS.PortalControls.dll) Version: 8.2.23
Syntax
C#
public abstract class CMSAbstractWebPart : AbstractUserControl, 
	ICMSVariantsControl, ICMSPortalControl, ITimeZoneManager, IDataControl, IRelatedData, 
	ISimpleDataContainer, IExceptionHandler

The CMSAbstractWebPart type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodClearCache
Causes clearing the control data cache, override to implement the data reloading procedure.
Protected methodCreateChildControls
Creates child controls within the web part.
(Overrides ControlCreateChildControls.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEnsureVariants
Ensures the web part variants
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodExecuteForAllNested
Executes the given action for all nested web parts
Public methodGetBothResizerScript
Gets the script for horizontal resizer.
Public methodGetCacheDependency
Gets the cache dependency for the control.
Protected methodGetContainerId
Gets the ID of the container encapsulating the web part
Public methodGetDefaultCacheDependendencies
Gets the default cache dependencies for the data source.
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetHorizontalResizerScript
Gets the script for horizontal resizer.
Public methodGetIdentifier
Gets web part identifier.
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetString
Returns localized string.
(Inherited from AbstractUserControl.)
Public methodGetStringValue
Gets the string value of the web part
Public methodGetValue
Returns the value of the given web part property property.
Protected methodGetVariantID
Gets the variant ID for rendering
Public methodGetVerticalResizerScript
Gets the script for vertical resizer.
Protected methodGetWireframeText
Ensures that the given text is not empty
Public methodLoadContent
Load the content to the web part.
Protected methodLoadStep
Loads the step.
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodLogEval
Logs the evaluation of the given column to the debug
Public methodOnContentLoaded
Method that is called when the page content is loaded, override to implement the control initialization after the content has been loaded.
Protected methodOnInit
Init event handler.
(Overrides AbstractUserControlOnInit(EventArgs).)
Protected methodOnLoad
Load event handler.
(Overrides AbstractUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Overrides AbstractUserControlOnPreRender(EventArgs).)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Causes reloading the data, override to implement the data reloading procedure.
Public methodRemoveVariantFromCache
Removes the variant from cache.
Protected methodRender
Renders the control.
(Overrides AbstractUserControlRender(HtmlTextWriter).)
Public methodResolveMacros
Resolves the macros within current WebPart context.
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Protected methodSaveStepData
Saves the wizard step data.
Public methodSetContext
Sets the web part context.
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodStepFinished
Allows you to execute additional logic after finish/save step event.
Protected methodStepLoaded
Allows you to execute additional logic after load step event.
Protected methodValidateStepData
Validates the wizard step data.
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 MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
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 MethodReportException
Reports the exception within the control hierarchy by placing an exception report next to the given control.
(Defined by ControlsExtensions.)
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
Protected fieldconfigureScript
Script to fire the configuration dialog.
Protected fieldlblWebPartTitle
Web part title label.
Protected fieldlocationRendered
If true, the web part location script was already rendered
Protected fieldStatic membermCacheItems
List of the cache key items.
Protected fieldmContainer
Container info object.
Protected fieldmDisableMacros
If true, the macros are disabled.
Protected fieldmHeaderContainer
Container control for the design mode header.
Protected fieldmHeaderControl
Header control
Protected fieldmChildPagePlaceholders
First level child page placeholders.
Protected fieldmIsDesign
True if the web part is in design mode.
Protected fieldmLocalProperties
Local web part properties.
Protected fieldmNeedsLayoutScript
If true, the web part needs the layouts script.
Protected fieldmNotResolveProperties
List of properties that should not be resolved.
Protected fieldmPageCycle
Control page cycle status.
Protected fieldmPageManager
Parent page manager.
Protected fieldmPagePlaceholder
Parent page placeholder.
Protected fieldmParentZone
Parent web part zone.
Protected fieldmParentZoneSearched
If true, the parent zone was already searched
Protected fieldmPartInfo
Web part info.
Protected fieldmProvideSetPropertyScript
If true, the script for setting the property if generated.
Protected fieldmRelatedData
Custom data connected to the object.
Protected fieldmRenderWebPartClass
If true, the web part class is rendered
Protected fieldmShortClientID
Short client ID.
Protected fieldmSQLProperties
List of SQL properties that should be escaped for SQL injection.
Protected fieldmStandAlone
Specifies whether the control is StandAlone or not, if false, the control is located within PortalEngine environment.
Protected fieldmTitleInfo
Title information.
Protected fieldmUpdatePanel
Update panel.
Protected fieldmViewMode
Local view mode.
Protected fieldplcTitleContainer
Web part title container
Public fieldStatic memberRESOLVER_RENDER
Web part render resolver name
Protected fieldvariantsLoaded
If true, the web part variants were already loaded
Protected fieldwidgetNotResolvePropertiesLoaded
Flag if the properties of widget that shouldn't be resolved were loaded.
Top
Properties
  NameDescription
Public propertyAdditonalCssClass
Gets or sets the additional class which is added to the web part content panel
Public propertyStatic memberAvailableCacheItemNames
Gets list of cache items supported by system
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
Public propertyCacheItemName
Name of the cache item the control will use.
Public propertyStatic memberCacheItems
List of the cache key items for partial caching. Default value is "username;sitename;lang"
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyComments
Comments.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContainer
Web part container object.
Public propertyContainerAfter
Container to render after the control.
Public propertyContainerBefore
Container to render before the control.
Public propertyContainerHideOnCurrentPage
Returns true if the container should be hidden on current page (hide container on subpages in effect).
Public propertyContainerHideOnSubPages
Hide container on sub pages.
Public propertyContainerName
Container name.
Public propertyContainerTitle
Container title.
Public propertyContentAfter
Content after.
Public propertyContentBefore
Content before.
Public propertyContentLoaded
Content has been loaded.
Public propertyContextResolver
Web part context resolver.
Public propertyControlContext
Control context.
Protected propertyCPWebPartInEdit
Indicates whether this web part is in edit mode and contains content personalization variants. According to this setting, the web part context menu will be rendered in the edit mode.
Public propertyCssClass
Web part CSS class.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentSiteName
Site name.
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyCustomTimeZone
Returns custom time zone info.
Public propertyDisableMacros
If true, macros are not resolved in the web part properties.
Public propertyDisableViewState
Allows disabling of the web part viewstate.
Public propertyDisplayToRoles
Display to roles.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Protected propertyDocumentWizardManager
Gets or sets current document wizard manager
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyEnabled
Enabled.
Public propertyEnableOutputFilter
Enable output filter
Public propertyHasVariants
Indicates whether the web part has any variants.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyHideHeader
If true, the header of the web part is hidden in design mode
Public propertyHideOnCurrentPage
Returns true if the control should be hidden on current page (hide control on subpages in effect).
Public propertyHideOnSubPages
Hide on sub pages.
Public propertyChildPagePlaceholders
Returns the table of all the inner placeholders.
Public propertyChildrenHaveVariants
Returns true if the children components have any variants
Public propertyInstanceGUID
Web part instance GUID.
Public propertyIsDesign
True if the web part is in design mode.
Public propertyIsLayout
Returns true, if the web part represents layout
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyIsVariant
Indicates whether this web part is a variant of an existing web part.
Public propertyIsVisible
Returns true if the webpart is visible.
Public propertyIsWidget
Returns true if the web part is widget.
Public propertyIsWireframe
Returns true if the web part represents wireframe
Public propertyItem
Gets or sets the value of the property
Public propertyLayoutType
Layout type of the parent zone
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNestedWebParts
Nested web parts
Public propertyNotResolveProperties
List of the property names that should not be resolved with macros.
Public propertyOutputConvertTablesToDivs
Convert TABLE tags to DIV tags
Public propertyOutputFixAttributes
Fix attributes
Public propertyOutputFixHTML5
Fix HTML5
Public propertyOutputFixJavascript
Fix Javascript
Public propertyOutputFixLowerCase
Fix lower case
Public propertyOutputFixSelfClose
Fix self closing tags
Public propertyOutputResolveURLs
Resolve URLs
Public propertyPageCycle
Control page cycle status.
Public propertyPageManager
Parent page manager.
Public propertyPagePlaceholder
Parent page placeholder.
Public propertyParentHasVariants
Returns true if the parent component has any variants
Public propertyParentWebPart
Parent web part, defined in case the web part is a nested web part in another web part.
Public propertyParentZone
Parent zone.
Public propertyPartInfo
Web part info.
Public propertyPartInstance
Web part instance.
Public propertyPortalManager
Portal manager for the page.
Public propertyRelatedData
Custom data connected to the object.
Public propertyRemoved
True if the web part was removed from current template.
Public propertyRenderEnvelope
If true, the web part renders div with web part client ID around it.
Public propertyShortClientID
Returns the short client ID of the web part.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowForDocumentTypes
Show for document types.
Public propertySimpleRender
If true, the web part renders as simple as possible
Public propertySkinID
Skin ID.
(Overrides ControlSkinID.)
Public propertySQLProperties
List of the property names that are used in SQL queries and should avoid SQL injection.
Public propertyStandAlone
Specifies whether the control is StandAlone or not, if false, the control is located within PortalEngine environment.
Public propertyStopProcessing
Returns true if the control processing should be stopped.
(Overrides AbstractUserControlStopProcessing.)
Public propertyTimeZoneType
Returns time zone type.
Protected propertyTitleContainer
Web part title container
Public propertyTitleInfo
Title information.
Public propertyTitleLabel
Gets the web part title label.
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyUpdatePanel
Update panel of the web part.
Public propertyUseContainer
Flag if the container should be used for the wireframe web part.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyUseUpdatePanel
Use update panel. This property is working only in Portal Engine mode. Don't use with ASPX templates.
Protected propertyVariantControlsPlaceHolder
Placeholder containing a list of variants used for an explicit rendering.
Public propertyViewMode
Page mode of the current web part.
Public propertyVisible
Gets or sets whether the control is visible on the page.
(Overrides ControlVisible.)
Public propertyWebPartHeight
Height of the web part
Public propertyWebPartID
Returns the Web part ID as registered in design mode
Public propertyWebPartTitle
Web part title.
Public propertyWebPartType
Returns the web part type.
Public propertyWebPartWidth
Width of the web part
Public propertyWidgetTitle
Widget title.
Top
See Also
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.ExtendedControlsAbstractUserControl
          CMS.PortalControlsCMSAbstractWebPart
            CMS.PortalControlsCMSAbstractEditableWebPart
            CMS.PortalControlsCMSAbstractLanguageWebPart
            CMS.PortalControlsCMSAbstractLayoutWebPart
            CMS.PortalControlsCMSAbstractWireframeWebPart
            CMS.PortalControlsCMSAbstractWizardWebPart
            CMS.PortalControlsWebPartAccessDenied
            CMS.PortalControlsWebPartError
            CMS.SocialMediaSocialMediaAbstractWebPart
            CMS.UIControlsCMSAbstractUIWebpart