Click or drag to resize
CMSAbstractUIWebpart Class
Abstract class for web parts used in UI
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 10.0.0
Syntax
C#
public abstract class CMSAbstractUIWebpart : CMSAbstractWebPart, 
	IUIElementControl

The CMSAbstractUIWebpart type exposes the following members.

Constructors
  NameDescription
Protected methodCMSAbstractUIWebpart
Top
Fields
  NameDescription
Protected fieldconfigureScript
Script to fire the configuration dialog.
(Inherited from CMSAbstractWebPart.)
Protected fieldlblWebPartTitle
Web part title label.
(Inherited from CMSAbstractWebPart.)
Protected fieldlocationRendered
If true, the web part location script was already rendered
(Inherited from CMSAbstractWebPart.)
Protected fieldmContainer
Container info object.
(Inherited from CMSAbstractWebPart.)
Protected fieldmDisableMacros
If true, the macros are disabled.
(Inherited from CMSAbstractWebPart.)
Protected fieldmHeaderContainer
Container control for the design mode header.
(Inherited from CMSAbstractWebPart.)
Protected fieldmHeaderControl
Header control
(Inherited from CMSAbstractWebPart.)
Protected fieldmChildPagePlaceholders
First level child page placeholders.
(Inherited from CMSAbstractWebPart.)
Protected fieldmIsDesign
True if the web part is in design mode.
(Inherited from CMSAbstractWebPart.)
Protected fieldmLocalProperties
Local web part properties.
(Inherited from CMSAbstractWebPart.)
Protected fieldmNeedsLayoutScript
If true, the web part needs the layouts script.
(Inherited from CMSAbstractWebPart.)
Protected fieldmNotResolveProperties
List of properties that should not be resolved.
(Inherited from CMSAbstractWebPart.)
Protected fieldmPageCycle
Control page cycle status.
(Inherited from CMSAbstractWebPart.)
Protected fieldmPageManager
Parent page manager.
(Inherited from CMSAbstractWebPart.)
Protected fieldmPagePlaceholder
Parent page placeholder.
(Inherited from CMSAbstractWebPart.)
Protected fieldmParentZone
Parent web part zone.
(Inherited from CMSAbstractWebPart.)
Protected fieldmParentZoneSearched
If true, the parent zone was already searched
(Inherited from CMSAbstractWebPart.)
Protected fieldmPartInfo
Web part info.
(Inherited from CMSAbstractWebPart.)
Protected fieldmProvideSetPropertyScript
If true, the script for setting the property if generated.
(Inherited from CMSAbstractWebPart.)
Protected fieldmRelatedData
Custom data connected to the object.
(Inherited from CMSAbstractWebPart.)
Protected fieldmRenderWebPartClass
If true, the web part class is rendered
(Inherited from CMSAbstractWebPart.)
Protected fieldmShortClientID
Short client ID.
(Inherited from CMSAbstractWebPart.)
Protected fieldmSQLProperties
List of SQL properties that should be escaped for SQL injection.
(Inherited from CMSAbstractWebPart.)
Protected fieldmStandAlone
Specifies whether the control is StandAlone or not, if false, the control is located within PortalEngine environment.
(Inherited from CMSAbstractWebPart.)
Protected fieldmTitleInfo
Title information.
(Inherited from CMSAbstractWebPart.)
Protected fieldmViewMode
Local view mode.
(Inherited from CMSAbstractWebPart.)
Protected fieldplcTitleContainer
Web part title container
(Inherited from CMSAbstractWebPart.)
Protected fieldvariantsLoaded
If true, the web part variants were already loaded
(Inherited from CMSAbstractWebPart.)
Protected fieldwidgetNotResolvePropertiesLoaded
Flag if the properties of widget that shouldn't be resolved were loaded.
(Inherited from CMSAbstractWebPart.)
Top
Properties
  NameDescription
Public propertyAdditionalCssClass
Gets or sets the additional class which is added to the web part content panel
(Inherited from CMSAbstractWebPart.)
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractWebPart.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from CMSAbstractWebPart.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractWebPart.)
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContainer
Web part container object.
(Inherited from CMSAbstractWebPart.)
Public propertyContainerAfter
Container to render after the control.
(Inherited from CMSAbstractWebPart.)
Public propertyContainerBefore
Container to render before the control.
(Inherited from CMSAbstractWebPart.)
Public propertyContainerHideOnCurrentPage
Returns true if the container should be hidden on current page (hide container on subpages in effect).
(Inherited from CMSAbstractWebPart.)
Public propertyContainerHideOnSubPages
Hide container on sub pages.
(Inherited from CMSAbstractWebPart.)
Public propertyContainerName
Container name.
(Inherited from CMSAbstractWebPart.)
Public propertyContainerTitle
Container title.
(Inherited from CMSAbstractWebPart.)
Public propertyContentAfter
Content after.
(Inherited from CMSAbstractWebPart.)
Public propertyContentBefore
Content before.
(Inherited from CMSAbstractWebPart.)
Public propertyContentLoaded
Content has been loaded.
(Inherited from CMSAbstractWebPart.)
Public propertyContextResolver
Web part context resolver.
(Inherited from CMSAbstractWebPart.)
Public propertyControlContext
Control context.
(Inherited from CMSAbstractWebPart.)
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.
(Inherited from CMSAbstractWebPart.)
Public propertyCssClass
Web part CSS class.
(Inherited from CMSAbstractWebPart.)
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.
(Inherited from CMSAbstractWebPart.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyCustomTimeZone
Returns custom time zone info.
(Inherited from CMSAbstractWebPart.)
Public propertyDisableMacros
If true, macros are not resolved in the web part properties.
(Inherited from CMSAbstractWebPart.)
Public propertyDisableViewState
Allows disabling of the web part viewstate.
(Inherited from CMSAbstractWebPart.)
Public propertyDisplayBreadCrumbs
Indicates whether the control should display breadcrumbs
Protected propertyDisplayFooter
Gets or sets a value indicating whether the footer pane should be displayed.
Public propertyDisplayToRoles
Display to roles.
(Inherited from CMSAbstractWebPart.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Protected propertyDocumentWizardManager
Gets or sets current document wizard manager
(Inherited from CMSAbstractWebPart.)
Protected propertyEditedObject
Control's edited object
(Inherited from CMSAbstractWebPart.)
Public propertyElementName
Element's name
Public propertyEnabled
Enabled.
(Inherited from CMSAbstractWebPart.)
Public propertyEnableOutputFilter
Enable output filter
(Inherited from CMSAbstractWebPart.)
Public propertyHasVariants
Indicates whether the web part has any variants.
(Inherited from CMSAbstractWebPart.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyHideHeader
If true, the header of the web part is hidden in design mode
(Inherited from CMSAbstractWebPart.)
Public propertyHideOnCurrentPage
Returns true if the control should be hidden on current page (hide control on subpages in effect).
(Inherited from CMSAbstractWebPart.)
Public propertyHideOnSubPages
Hide on sub pages.
(Inherited from CMSAbstractWebPart.)
Public propertyChildPagePlaceholders
Returns the table of all the inner placeholders.
(Inherited from CMSAbstractWebPart.)
Public propertyChildrenHaveVariants
Returns true if the children components have any variants
(Inherited from CMSAbstractWebPart.)
Public propertyInstanceGUID
Web part instance GUID.
(Inherited from CMSAbstractWebPart.)
Public propertyIsDesign
True if the web part is in design mode.
(Inherited from CMSAbstractWebPart.)
Public propertyIsDialog
Indicates whether this instance is used in a dialog.
Public propertyIsLayout
Returns true, if the web part represents layout
(Inherited from CMSAbstractWebPart.)
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.
(Inherited from CMSAbstractWebPart.)
Public propertyIsVisible
Returns true if the webpart is visible.
(Inherited from CMSAbstractWebPart.)
Public propertyIsWidget
Returns true if the web part is widget.
(Inherited from CMSAbstractWebPart.)
Public propertyItem
Gets or sets the value of the property
(Inherited from CMSAbstractWebPart.)
Public propertyLayoutType
Layout type of the parent zone
(Inherited from CMSAbstractWebPart.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNestedWebParts
Nested web parts
(Inherited from CMSAbstractWebPart.)
Public propertyNotResolveProperties
List of the property names that should not be resolved with macros.
(Inherited from CMSAbstractWebPart.)
Public propertyObjectID
Gets object type of (created)edited object (if any)
Public propertyObjectType
Web part's object type. If not set, use default context's object type.
Public propertyOutputConvertTablesToDivs
Convert TABLE tags to DIV tags
(Inherited from CMSAbstractWebPart.)
Public propertyOutputFixAttributes
Fix attributes
(Inherited from CMSAbstractWebPart.)
Public propertyOutputFixHTML5
Fix HTML5
(Inherited from CMSAbstractWebPart.)
Public propertyOutputFixJavascript
Fix Javascript
(Inherited from CMSAbstractWebPart.)
Public propertyOutputFixLowerCase
Fix lower case
(Inherited from CMSAbstractWebPart.)
Public propertyOutputFixSelfClose
Fix self closing tags
(Inherited from CMSAbstractWebPart.)
Public propertyOutputResolveURLs
Resolve URLs
(Inherited from CMSAbstractWebPart.)
Public propertyPageCycle
Control page cycle status.
(Inherited from CMSAbstractWebPart.)
Public propertyPageManager
Parent page manager.
(Inherited from CMSAbstractWebPart.)
Public propertyPagePlaceholder
Parent page placeholder.
(Inherited from CMSAbstractWebPart.)
Public propertyParentHasVariants
Returns true if the parent component has any variants
(Inherited from CMSAbstractWebPart.)
Public propertyParentWebPart
Parent web part, defined in case the web part is a nested web part in another web part.
(Inherited from CMSAbstractWebPart.)
Public propertyParentZone
Parent zone.
(Inherited from CMSAbstractWebPart.)
Public propertyPartInfo
Web part info.
(Inherited from CMSAbstractWebPart.)
Public propertyPartInstance
Web part instance.
(Inherited from CMSAbstractWebPart.)
Public propertyPortalManager
Portal manager for the page.
(Inherited from CMSAbstractWebPart.)
Public propertyRelatedData
Custom data connected to the object.
(Inherited from CMSAbstractWebPart.)
Public propertyRemoved
True if the web part was removed from current template.
(Inherited from CMSAbstractWebPart.)
Public propertyRenderEnvelope
If true, the web part renders div with web part client ID around it.
(Inherited from CMSAbstractWebPart.)
Public propertyResourceName
UI element's resource name
Public propertyResourcePrefix
Prefix for the resource strings which are used for the localization.
(Inherited from CMSAbstractWebPart.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyRootElementID
Gets the root element ID. Root UI element holds the very top UIElement which is open in a dialog.
Public propertyShortClientID
Returns the short client ID of the web part.
(Inherited from CMSAbstractWebPart.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowForDocumentTypes
Show for document types.
(Inherited from CMSAbstractWebPart.)
Public propertySkinID
Skin ID.
(Inherited from CMSAbstractWebPart.)
Public propertySQLProperties
List of the property names that are used in SQL queries and should avoid SQL injection.
(Inherited from CMSAbstractWebPart.)
Public propertyStandAlone
Specifies whether the control is StandAlone or not, if false, the control is located within PortalEngine environment.
(Inherited from CMSAbstractWebPart.)
Public propertyStopProcessing
Returns true if the control processing should be stopped.
(Inherited from CMSAbstractWebPart.)
Public propertyTimeZoneType
Returns time zone type.
(Inherited from CMSAbstractWebPart.)
Protected propertyTitleContainer
Web part title container
(Inherited from CMSAbstractWebPart.)
Public propertyTitleInfo
Title information.
(Inherited from CMSAbstractWebPart.)
Public propertyTitleLabel
Gets the web part title label.
(Inherited from CMSAbstractWebPart.)
Public propertyTitleText
Text of title
Protected propertyUIContext
Control's UI Context
(Inherited from CMSAbstractWebPart.)
Public propertyUpdatePanel
Update panel of the web part.
(Inherited from CMSAbstractWebPart.)
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.
(Inherited from CMSAbstractWebPart.)
Protected propertyVariantControlsPlaceHolder
Placeholder containing a list of variants used for an explicit rendering.
(Inherited from CMSAbstractWebPart.)
Public propertyViewMode
Page mode of the current web part.
(Inherited from CMSAbstractWebPart.)
Public propertyVisible
Gets or sets whether the control is visible on the page.
(Inherited from CMSAbstractWebPart.)
Public propertyWebPartHeight
Height of the web part
(Inherited from CMSAbstractWebPart.)
Public propertyWebPartID
Returns the Web part ID as registered in design mode
(Inherited from CMSAbstractWebPart.)
Public propertyWebPartTitle
Web part title.
(Inherited from CMSAbstractWebPart.)
Public propertyWebPartType
Returns the web part type.
(Inherited from CMSAbstractWebPart.)
Public propertyWebPartWidth
Width of the web part
(Inherited from CMSAbstractWebPart.)
Public propertyWidgetTitle
Widget title.
(Inherited from CMSAbstractWebPart.)
Top
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.
(Inherited from CMSAbstractWebPart.)
Protected methodCreateChildControls
Creates child controls within the web part.
(Inherited from CMSAbstractWebPart.)
Public methodDisplayBreadcrumbs
Indicates whether the breadcrumbs should be displayed according to the given UIContext.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEnsureVariants
Ensures the web part variants
(Inherited from CMSAbstractWebPart.)
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
(Inherited from CMSAbstractWebPart.)
Protected methodGetBoolContextValue
Returns bool property value. If property is not set, returns value from the UI context with the same name.
Public methodGetBothResizerScript
Gets the script for horizontal resizer.
(Inherited from CMSAbstractWebPart.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractWebPart.)
Protected methodGetContainerId
Gets the ID of the container encapsulating the web part
(Inherited from CMSAbstractWebPart.)
Public methodGetDefaultCacheDependendencies
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractWebPart.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetHorizontalResizerScript
Gets the script for horizontal resizer.
(Inherited from CMSAbstractWebPart.)
Public methodGetIdentifier
Gets web part identifier.
(Inherited from CMSAbstractWebPart.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Protected methodGetIntContextValue
Returns int property value. If value is empty, try to get it from UI context.
Protected methodGetSiteID
Get site ID either from context or use current site ID
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Protected methodGetStringContextValue
Returns string property value. If value is empty, try to get it from UI context.
Public methodGetStringValue
Gets the string value of the web part
(Inherited from CMSAbstractWebPart.)
Public methodGetValue
Returns the value of the given web part property property.
(Inherited from CMSAbstractWebPart.)
Protected methodGetVariantID
Gets the variant ID for rendering
(Inherited from CMSAbstractWebPart.)
Public methodGetVerticalResizerScript
Gets the script for vertical resizer.
(Inherited from CMSAbstractWebPart.)
Protected methodCheckEditPermissions
Returns if element is authorized per modifying object
Protected methodCheckUIPermissions
Check permissions for UI elements
Protected methodCheckViewPermissions
Returns if user is allowed to read content based on content's object type
Public methodLoadContent
Load the content to the web part.
(Inherited from CMSAbstractWebPart.)
Protected methodLoadStep
Loads the step.
(Inherited from CMSAbstractWebPart.)
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
(Inherited from CMSAbstractWebPart.)
Protected methodManagePaneTitle
Handles displaying page title and breadcrumbs
Protected methodManageTexts
Displays all information to messages placeholder based by element's properties
Protected methodManageVersionTab
Adds version tab to collection.
Public methodOnContentLoaded
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 methodOnInit
Init event handler.
(Inherited from CMSAbstractWebPart.)
Protected methodOnLoad
Load event handler.
(Inherited from CMSAbstractWebPart.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from CMSAbstractWebPart.)
Protected methodRegisterBreadcrumbsScript
Registers the breadcrumbs script
Public methodReleaseContext
Releases the web part context.
(Inherited from CMSAbstractWebPart.)
Public methodReloadData
Causes reloading the data, override to implement the data reloading procedure.
(Inherited from CMSAbstractWebPart.)
Public methodRemoveVariantFromCache
Removes the variant from cache.
(Inherited from CMSAbstractWebPart.)
Protected methodRender
Renders the control.
(Inherited from CMSAbstractWebPart.)
Public methodResolveMacros
Resolves the macros within current WebPart context.
(Inherited from CMSAbstractWebPart.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Protected methodSaveStepData
Saves the wizard step data.
(Inherited from CMSAbstractWebPart.)
Public methodSetBreadcrumbs
Sets breadcrumbs based on UI context data
Public methodSetContext
Sets the web part context.
(Inherited from CMSAbstractWebPart.)
Protected methodSetHeaderControls
Initializes the page controls
Public methodSetTitle
Sets title based on UI context data
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from CMSAbstractWebPart.)
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.
(Inherited from CMSAbstractWebPart.)
Protected methodStepLoaded
Allows you to execute additional logic after load step event.
(Inherited from CMSAbstractWebPart.)
Protected methodValidateStepData
Validates the wizard step data.
(Inherited from CMSAbstractWebPart.)
Top
Extension Methods
  NameDescription
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also