CMSAbstractLayoutWebPart Class

Layout web part containing further zones.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.PortalEngine.Web.UI.CMSAbstractWebPart
            CMS.PortalEngine.Web.UI.CMSAbstractLayoutWebPart

Namespace: CMS.PortalEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131

Syntax

public abstract class CMSAbstractLayoutWebPart : CMSAbstractWebPart

The CMSAbstractLayoutWebPart type exposes the following members.

Constructors

	Name	Description
Public method	CMSAbstractLayoutWebPart	Constructor.

Fields

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

Properties

	Name	Description
Public property	AdditionalCssClass	Gets or sets the additional class which is added to the web part content panel (Inherited from CMSAbstractWebPart.)
Public property	AllowDesignMode	Allow design mode.
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from CMSAbstractWebPart.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from CMSAbstractWebPart.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from CMSAbstractWebPart.)
Public property	ChildPagePlaceholders	Returns the table of all the inner placeholders. (Inherited from CMSAbstractWebPart.)
Public property	ChildrenHaveVariants	Returns true if the children components have any variants (Overrides CMSAbstractWebPart.ChildrenHaveVariants.)
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	Container	Web part container object. (Inherited from CMSAbstractWebPart.)
Public property	ContainerAfter	Container to render after the control. (Inherited from CMSAbstractWebPart.)
Public property	ContainerBefore	Container to render before the control. (Inherited from CMSAbstractWebPart.)
Public property	ContainerHideOnCurrentPage	Returns true if the container should be hidden on current page (hide container on subpages in effect). (Inherited from CMSAbstractWebPart.)
Public property	ContainerHideOnSubPages	Hide container on sub pages. (Inherited from CMSAbstractWebPart.)
Public property	ContainerName	Container name. (Inherited from CMSAbstractWebPart.)
Public property	ContainerTitle	Container title. (Inherited from CMSAbstractWebPart.)
Public property	ContentAfter	Content after. (Inherited from CMSAbstractWebPart.)
Public property	ContentBefore	Content before. (Inherited from CMSAbstractWebPart.)
Public property	ContentLoaded	Content has been loaded. (Inherited from CMSAbstractWebPart.)
Public property	ContextResolver	Web part context resolver. (Inherited from CMSAbstractWebPart.)
Public property	ControlContext	Control context. (Inherited from CMSAbstractWebPart.)
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. (Inherited from CMSAbstractWebPart.)
Public property	CssClass	Web part CSS class. (Inherited from CMSAbstractWebPart.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentSiteName	Site name. (Inherited from CMSAbstractWebPart.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	CustomTimeZone	Returns custom time zone info. (Inherited from CMSAbstractWebPart.)
Public property	DisableMacros	If true, macros are not resolved in the web part properties. (Inherited from CMSAbstractWebPart.)
Public property	DisableViewState	Allows disabling of the web part viewstate. (Inherited from CMSAbstractWebPart.)
Public property	DisplayToRoles	Display to roles. (Inherited from CMSAbstractWebPart.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Protected property	DocumentWizardManager	Gets or sets current document wizard manager (Inherited from CMSAbstractWebPart.)
Protected property	EditedObject	Control's edited object (Inherited from CMSAbstractWebPart.)
Public property	Enabled	Enabled. (Inherited from CMSAbstractWebPart.)
Public property	HasVariants	Indicates whether the web part has any variants. (Inherited from CMSAbstractWebPart.)
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 (Inherited from CMSAbstractWebPart.)
Public property	HideOnCurrentPage	Returns true if the control should be hidden on current page (hide control on subpages in effect). (Inherited from CMSAbstractWebPart.)
Public property	HideOnSubPages	Hide on sub pages. (Inherited from CMSAbstractWebPart.)
Public property	InstanceGUID	Web part instance GUID. (Inherited from CMSAbstractWebPart.)
Public property	IsDesign	True if the web part is in design mode. (Inherited from CMSAbstractWebPart.)
Public property	IsLayout	Returns true, if the web part represents layout (Inherited from CMSAbstractWebPart.)
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. (Inherited from CMSAbstractWebPart.)
Public property	IsVisible	Returns true if the web part is visible. (Overrides CMSAbstractWebPart.IsVisible.)
Public property	IsWidget	Returns true if the web part is widget. (Inherited from CMSAbstractWebPart.)
Public property	Item	Gets or sets the value of the property (Inherited from CMSAbstractWebPart.)
Public property	LayoutType	Layout type of the parent zone (Inherited from CMSAbstractWebPart.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	NotResolveProperties	List of the property names that should not be resolved with macros. (Inherited from CMSAbstractWebPart.)
Public property	PageCycle	Control page cycle status. (Inherited from CMSAbstractWebPart.)
Public property	PageManager	Parent page manager. (Inherited from CMSAbstractWebPart.)
Public property	PagePlaceholder	Parent page placeholder. (Inherited from CMSAbstractWebPart.)
Public property	ParentHasVariants	Returns true if the parent component has any variants (Inherited from CMSAbstractWebPart.)
Public property	ParentZone	Parent zone. (Inherited from CMSAbstractWebPart.)
Public property	PartInfo	Web part info. (Inherited from CMSAbstractWebPart.)
Public property	PartInstance	Web part instance. (Inherited from CMSAbstractWebPart.)
Public property	PortalManager	Portal manager for the page. (Inherited from CMSAbstractWebPart.)
Public property	RelatedData	Custom data connected to the object. (Inherited from CMSAbstractWebPart.)
Public property	Removed	True if the web part was removed from current template. (Inherited from CMSAbstractWebPart.)
Public property	RenderEnvelope	If true, the web part renders div with web part client ID around it. (Inherited from CMSAbstractWebPart.)
Public property	ResourcePrefix	Prefix for the resource strings which are used for the localization. (Inherited from CMSAbstractWebPart.)
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. (Inherited from CMSAbstractWebPart.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	ShowForDocumentTypes	Show for document types. (Inherited from CMSAbstractWebPart.)
Public property	SkinID	Skin ID. (Inherited from CMSAbstractWebPart.)
Public property	SQLProperties	List of the property names that are used in SQL queries and should avoid SQL injection. (Inherited from CMSAbstractWebPart.)
Public property	StandAlone	Specifies whether the control is StandAlone or not, if false, the control is located within PortalEngine environment. (Inherited from CMSAbstractWebPart.)
Public property	StopProcessing	Returns true if the control processing should be stopped. (Inherited from CMSAbstractWebPart.)
Public property	TimeZoneType	Returns time zone type. (Inherited from CMSAbstractWebPart.)
Protected property	TitleContainer	Web part title container (Inherited from CMSAbstractWebPart.)
Public property	TitleInfo	Title information. (Inherited from CMSAbstractWebPart.)
Public property	TitleLabel	Gets the web part title label. (Inherited from CMSAbstractWebPart.)
Protected property	UIContext	Control's UI Context (Inherited from CMSAbstractWebPart.)
Public property	UpdatePanel	Update panel of the web part. (Inherited from CMSAbstractWebPart.)
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. (Inherited from CMSAbstractWebPart.)
Protected property	VariantControlsPlaceHolder	Placeholder containing a list of variants used for an explicit rendering. (Inherited from CMSAbstractWebPart.)
Public property	ViewMode	Page mode of the current web part. (Inherited from CMSAbstractWebPart.)
Public property	Visible	Gets or sets whether the control is visible on the page. (Inherited from CMSAbstractWebPart.)
Public property	WebPartHeight	Height of the web part (Inherited from CMSAbstractWebPart.)
Public property	WebPartID	Returns the Web part ID as registered in design mode (Inherited from CMSAbstractWebPart.)
Public property	WebPartTitle	Web part title. (Inherited from CMSAbstractWebPart.)
Public property	WebPartType	Returns the web part type. (Inherited from CMSAbstractWebPart.)
Public property	WebPartWidth	Width of the web part (Inherited from CMSAbstractWebPart.)
Public property	WebPartZones	Web part zones list.
Public property	WidgetTitle	Widget title. (Inherited from CMSAbstractWebPart.)

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Protected method	AddControl(String)	Adds the control to the layout.
Protected method	AddControl(Control)	Adds the control to the layout.
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.)
Protected method	AddHeaderContainer	Adds the container for the header to the layout.
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.)
Protected method	AddWebPart	Adds the web part to the layout
Protected method	AddZone	Adds the zone with given ID to the layout.
Protected method	Append	Appends the given text to the layout.
Protected method	AppendAction	Appends the given action
Protected method	AppendAddAction	Appends the add to property action (increases by 1).
Protected method	AppendItemEnd	Appends the code to render the item end
Protected method	AppendItemsInfo	Appends the items information
Protected method	AppendItemStart	Appends the code to render the item start
Protected method	AppendNextItemAction	Appends the action to switch to the next item
Protected method	AppendPreviousItemAction	Appends the action to switch to the previous item
Protected method	AppendRemoveAction	Appends the add to property action (decreases by 1).
Public method	ClearCache	Causes clearing the control data cache, override to implement the data reloading procedure. (Inherited from CMSAbstractWebPart.)
Protected method	ClearLayout	Clears the currently generated layout
Protected method	CreateChildControls	Creates the control child controls (Overrides CMSAbstractWebPart.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 (Inherited from CMSAbstractWebPart.)
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	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (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	ExecuteForAllVariants	Executes the given action for all nested web parts (Inherited from CMSAbstractWebPart.)
Protected method	FinishLayout	Finishes the layout designing.
Public method	GetBothResizerScript	Gets the script for horizontal resizer. (Inherited from CMSAbstractWebPart.)
Public method	GetCacheDependency	Gets the cache dependency for the control. (Inherited from CMSAbstractWebPart.)
Protected method	GetContainerId	Gets the ID of the container encapsulating the web part (Inherited from CMSAbstractWebPart.)
Public method	GetDefaultCacheDependendencies	Gets the default cache dependencies for the data source. (Inherited from CMSAbstractWebPart.)
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. (Inherited from CMSAbstractWebPart.)
Public method	GetIdentifier	Gets web part identifier. (Inherited from CMSAbstractWebPart.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Protected method	GetLastCurrentItem	Gets the value of the last current item as saved in a cookie
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 (Inherited from CMSAbstractWebPart.)
Public method	GetValue	Returns the value of the given web part property property. (Inherited from CMSAbstractWebPart.)
Protected method	GetVariantID	Gets the variant ID for rendering (Inherited from CMSAbstractWebPart.)
Public method	GetVerticalResizerScript	Gets the script for vertical resizer. (Inherited from CMSAbstractWebPart.)
Public method	LoadContent	Load the content to the web part. (Inherited from CMSAbstractWebPart.)
Public method	LoadLayout	Loads the web part layout.
Protected method	LoadStep	Loads the step. (Inherited from CMSAbstractWebPart.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Protected method	LoadZones	Loads the web part zones contained within the web part.
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	LogEval	Logs the evaluation of the given column to the debug (Inherited from CMSAbstractWebPart.)
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. (Inherited from CMSAbstractWebPart.)
Protected method	OnInit	Init event handler. (Inherited from CMSAbstractWebPart.)
Protected method	OnLoad	Load event handler. (Inherited from CMSAbstractWebPart.)
Protected method	OnPreRender	PreRender event handler. (Inherited from CMSAbstractWebPart.)
Protected method	PrepareLayout	Prepares the web part layout.
Protected method	RegisterChangeLayoutItemScript	Registers the script that changes the currently displayed item of the wizard
Public method	ReleaseContext	Releases the web part context. (Inherited from CMSAbstractWebPart.)
Public method	ReloadData	Causes reloading the data, override to implement the data reloading procedure. (Inherited from CMSAbstractWebPart.)
Public method	RemoveVariantFromCache	Removes the variant from cache. (Inherited from CMSAbstractWebPart.)
Protected method	Render	Renders the control. (Inherited from CMSAbstractWebPart.)
Public method	ResolveMacros	Resolves the macros within current WebPart context. (Inherited from CMSAbstractWebPart.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Protected method	SaveStepData	Saves the wizard step data. (Inherited from CMSAbstractWebPart.)
Public method	SetContext	Sets the web part context. (Inherited from CMSAbstractWebPart.)
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from CMSAbstractWebPart.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
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	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	StartLayout	Starts the rendering of the layout.
Protected method	StepFinished	Allows you to execute additional logic after finish/save step event. (Inherited from CMSAbstractWebPart.)
Protected method	StepLoaded	Allows you to execute additional logic after load step event. (Inherited from CMSAbstractWebPart.)
Protected method	ValidateStepData	Validates the wizard step data. (Inherited from CMSAbstractWebPart.)
Protected method	ViewModeIsDesign	Returns true, if the web part view mode is design mode

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.)