CMSAbstractWebPart Class

Base class for the web part controls.

Base class for the web part controls.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          CMS.PortalControls.CMSAbstractWebPart
            More...

Namespace: CMS.PortalControls
Assembly: CMS.PortalControls (in CMS.PortalControls.dll) Version: 9.0.0

Syntax

public abstract class CMSAbstractWebPart : AbstractUserControl, 
	ICMSVariantsControl, ICMSPortalControl, ITimeZoneManager, IDataControl, IRelatedData, 
	ISimpleDataContainer, IExceptionHandler

The CMSAbstractWebPart type exposes the following members.

Constructors

	Name	Description
Protected method	CMSAbstractWebPart()	Constructor.
Protected method	CMSAbstractWebPart(CMSPagePlaceholder)	Constructor, initializes the parent portal manager.

Fields

	Name	Description
Protected field	configureScript	Script to fire the configuration dialog.
Protected field	lblWebPartTitle	Web part title label.
Protected field	locationRendered	If true, the web part location script was already rendered
Protected field Static member	mCacheItems	List of the cache key items.
Protected field	mContainer	Container info object.
Protected field	mDisableMacros	If true, the macros are disabled.
Protected field	mHeaderContainer	Container control for the design mode header.
Protected field	mHeaderControl	Header control
Protected field	mChildPagePlaceholders	First level child page placeholders.
Protected field	mIsDesign	True if the web part is in design mode.
Protected field	mLocalProperties	Local web part properties.
Protected field	mNeedsLayoutScript	If true, the web part needs the layouts script.
Protected field	mNotResolveProperties	List of properties that should not be resolved.
Protected field	mPageCycle	Control page cycle status.
Protected field	mPageManager	Parent page manager.
Protected field	mPagePlaceholder	Parent page placeholder.
Protected field	mParentZone	Parent web part zone.
Protected field	mParentZoneSearched	If true, the parent zone was already searched
Protected field	mPartInfo	Web part info.
Protected field	mProvideSetPropertyScript	If true, the script for setting the property if generated.
Protected field	mRelatedData	Custom data connected to the object.
Protected field	mRenderWebPartClass	If true, the web part class is rendered
Protected field	mShortClientID	Short client ID.
Protected field	mSQLProperties	List of SQL properties that should be escaped for SQL injection.
Protected field	mStandAlone	Specifies whether the control is StandAlone or not, if false, the control is located within PortalEngine environment.
Protected field	mTitleInfo	Title information.
Protected field	mViewMode	Local view mode.
Protected field	plcTitleContainer	Web part title container
Public field Static member	RESOLVER_RENDER	Web part render resolver name
Protected field	variantsLoaded	If true, the web part variants were already loaded
Protected field	widgetNotResolvePropertiesLoaded	Flag if the properties of widget that shouldn't be resolved were loaded.

Properties

	Name	Description
Public property	AdditonalCssClass	Gets or sets the additional class which is added to the web part content panel
Public property Static member	AvailableCacheItemNames	Gets list of cache items supported by system
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property Static member	CacheItems	List of the cache key items for partial caching. Default value is "username;sitename;lang"
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	Container	Web part container object.
Public property	ContainerAfter	Container to render after the control.
Public property	ContainerBefore	Container to render before the control.
Public property	ContainerHideOnCurrentPage	Returns true if the container should be hidden on current page (hide container on subpages in effect).
Public property	ContainerHideOnSubPages	Hide container on sub pages.
Public property	ContainerName	Container name.
Public property	ContainerTitle	Container title.
Public property	ContentAfter	Content after.
Public property	ContentBefore	Content before.
Public property	ContentLoaded	Content has been loaded.
Public property	ContextResolver	Web part context resolver.
Public property	ControlContext	Control context.
Protected property	CPWebPartInEdit	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 property	CssClass	Web part CSS class.
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentSiteName	Site name.
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	CustomTimeZone	Returns custom time zone info.
Public property	DisableMacros	If true, macros are not resolved in the web part properties.
Public property	DisableViewState	Allows disabling of the web part viewstate.
Public property	DisplayToRoles	Display to roles.
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Protected property	DocumentWizardManager	Gets or sets current document wizard manager
Public property	EditedObject	Control's edited object (Inherited from AbstractUserControl.)
Public property	Enabled	Enabled.
Public property	EnableOutputFilter	Enable output filter
Public property	HasVariants	Indicates whether the web part has any variants.
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	HideHeader	If true, the header of the web part is hidden in design mode
Public property	HideOnCurrentPage	Returns true if the control should be hidden on current page (hide control on subpages in effect).
Public property	HideOnSubPages	Hide on sub pages.
Public property	ChildPagePlaceholders	Returns the table of all the inner placeholders.
Public property	ChildrenHaveVariants	Returns true if the children components have any variants
Public property	InstanceGUID	Web part instance GUID.
Public property	IsDesign	True if the web part is in design mode.
Public property	IsLayout	Returns true, if the web part represents layout
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	IsVariant	Indicates whether this web part is a variant of an existing web part.
Public property	IsVisible	Returns true if the webpart is visible.
Public property	IsWidget	Returns true if the web part is widget.
Public property	Item	Gets or sets the value of the property
Public property	LayoutType	Layout type of the parent zone
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	NestedWebParts	Nested web parts
Public property	NotResolveProperties	List of the property names that should not be resolved with macros.
Public property	OutputConvertTablesToDivs	Convert TABLE tags to DIV tags
Public property	OutputFixAttributes	Fix attributes
Public property	OutputFixHTML5	Fix HTML5
Public property	OutputFixJavascript	Fix Javascript
Public property	OutputFixLowerCase	Fix lower case
Public property	OutputFixSelfClose	Fix self closing tags
Public property	OutputResolveURLs	Resolve URLs
Public property	PageCycle	Control page cycle status.
Public property	PageManager	Parent page manager.
Public property	PagePlaceholder	Parent page placeholder.
Public property	ParentHasVariants	Returns true if the parent component has any variants
Public property	ParentWebPart	Parent web part, defined in case the web part is a nested web part in another web part.
Public property	ParentZone	Parent zone.
Public property	PartInfo	Web part info.
Public property	PartInstance	Web part instance.
Public property	PortalManager	Portal manager for the page.
Public property	RelatedData	Custom data connected to the object.
Public property	Removed	True if the web part was removed from current template.
Public property	RenderEnvelope	If true, the web part renders div with web part client ID around it.
Public property	ResourcePrefix	Prefix for the resource strings which are used for the localization. (Overrides AbstractUserControl.ResourcePrefix.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	ShortClientID	Returns the short client ID of the web part.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	ShowForDocumentTypes	Show for document types.
Public property	SkinID	Skin ID. (Overrides Control.SkinID.)
Public property	SQLProperties	List of the property names that are used in SQL queries and should avoid SQL injection.
Public property	StandAlone	Specifies whether the control is StandAlone or not, if false, the control is located within PortalEngine environment.
Public property	StopProcessing	Returns true if the control processing should be stopped. (Overrides AbstractUserControl.StopProcessing.)
Public property	TimeZoneType	Returns time zone type.
Protected property	TitleContainer	Web part title container
Public property	TitleInfo	Title information.
Public property	TitleLabel	Gets the web part title label.
Public property	UIContext	Control's UI Context (Inherited from AbstractUserControl.)
Public property	UpdatePanel	Update panel of the web part.
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	UseUpdatePanel	Use update panel. This property is working only in Portal Engine mode. Don't use with ASPX templates.
Protected property	VariantControlsPlaceHolder	Placeholder containing a list of variants used for an explicit rendering.
Public property	ViewMode	Page mode of the current web part.
Public property	Visible	Gets or sets whether the control is visible on the page. (Overrides Control.Visible.)
Public property	WebPartHeight	Height of the web part
Public property	WebPartID	Returns the Web part ID as registered in design mode
Public property	WebPartTitle	Web part title.
Public property	WebPartType	Returns the web part type.
Public property	WebPartWidth	Width of the web part
Public property	WidgetTitle	Widget title.

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	ClearCache	Causes clearing the control data cache, override to implement the data reloading procedure.
Protected method	CreateChildControls	Creates child controls within the web part. (Overrides Control.CreateChildControls().)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	EnsureVariants	Ensures the web part variants
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	ExecuteForAllNested	Executes the given action for all nested web parts
Public method	GetBothResizerScript	Gets the script for horizontal resizer.
Public method	GetCacheDependency	Gets the cache dependency for the control.
Protected method	GetContainerId	Gets the ID of the container encapsulating the web part
Public method	GetDefaultCacheDependendencies	Gets the default cache dependencies for the data source.
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetHorizontalResizerScript	Gets the script for horizontal resizer.
Public method	GetIdentifier	Gets web part identifier.
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetStringValue	Gets the string value of the web part
Public method	GetValue	Returns the value of the given web part property property.
Protected method	GetVariantID	Gets the variant ID for rendering
Public method	GetVerticalResizerScript	Gets the script for vertical resizer.
Public method	LoadContent	Load the content to the web part.
Protected method	LoadStep	Loads the step.
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	LogEval	Logs the evaluation of the given column to the debug
Public method	OnContentLoaded	Method that is called when the page content is loaded, override to implement the control initialization after the content has been loaded.
Protected method	OnInit	Init event handler. (Overrides AbstractUserControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Overrides AbstractUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Overrides AbstractUserControl.OnPreRender(EventArgs).)
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	Causes reloading the data, override to implement the data reloading procedure.
Public method	RemoveVariantFromCache	Removes the variant from cache.
Protected method	Render	Renders the control. (Overrides AbstractUserControl.Render(HtmlTextWriter).)
Public method	ResolveMacros	Resolves the macros within current WebPart context.
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Protected method	SaveStepData	Saves the wizard step data.
Public method	SetContext	Sets the web part context.
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value.
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	StepFinished	Allows you to execute additional logic after finish/save step event.
Protected method	StepLoaded	Allows you to execute additional logic after load step event.
Protected method	ValidateStepData	Validates the wizard step data.

Extension Methods

	Name	Description
Public Extension Method	CallHandled	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 Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
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	ReportException	Reports the exception within the control hierarchy by placing an exception report next to the given control. (Defined by ControlsExtensions.)