CMSAbstractUIWebpart MembersKentico 8.0 API Reference
The CMSAbstractUIWebpart type exposes the following members.
Constructors

  NameDescription
Protected methodCMSAbstractUIWebpart
Back to Top
Methods

  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodOnlineAddedControl
Called after a child control is added to the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
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.)
Protected methodOnlineAddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's OnlineControlCollection object.
(Inherited from OnlineControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodOnlineApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from OnlineControl.)
Protected methodOnlineBuildProfileTree
Gathers information about the server control and delivers it to the OnlineTrace property to be displayed when tracing is enabled for the page.
(Inherited from OnlineControl.)
Public methodClearCache
Causes clearing the control data cache, override to implement the data reloading procedure.
(Inherited from CMSAbstractWebPart.)
Protected methodOnlineClearCachedClientID
Sets the cached OnlineClientID value to null.
(Inherited from OnlineControl.)
Protected methodOnlineClearEffectiveClientIDMode
Sets the OnlineClientIDMode property of the current control instance and of any child controls to OnlineInherit.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineConstruct
Performs design-time logic.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineCreateControlCollection
Creates a new OnlineControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from OnlineControl.)
Protected methodCreateChildControls
Creates child controls within the web part.
(Inherited from CMSAbstractWebPart.)
Protected methodOnlineCreateResourceBasedLiteralControl
Accesses literal strings stored in a resource. The OnlineCreateResourceBasedLiteralControl(Int32, Int32, Boolean) method is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Public methodOnlineDataBind 
Binds a data source to the invoked server control and all its child controls.
(Inherited from OnlineControl.)
Protected methodOnlineDataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from OnlineControl.)
Public methodOnlineDesignerInitialize
Performs any initialization steps on the user control that are required by RAD designers.
(Inherited from OnlineUserControl.)
Public methodDisplayBreadcrumbs
Indicates whether the breadcrumbs should be displayed according to the given UIContext.
Public methodOnlineDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from OnlineControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Protected methodOnlineEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from OnlineControl.)
Protected methodOnlineEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from OnlineControl.)
Public methodEnsureVariants
Ensures the web part variants
(Inherited from CMSAbstractWebPart.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
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.)
Protected methodOnlineEval(String, String)
Evaluates a data-binding expression using the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
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 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 methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from OnlineControl.)
Protected methodOnlineFindControl(String, Int32)
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the OnlineFindControl  method.
(Inherited from OnlineControl.)
Public methodOnlineFocus
Sets input focus to a control.
(Inherited from OnlineControl.)
Protected methodOnlineFrameworkInitialize
Initializes the control that is derived from the OnlineTemplateControl class.
(Inherited from OnlineTemplateControl.)
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.)
Protected methodOnlineGetDesignModeState
Gets design-time data for a control.
(Inherited from OnlineControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Protected methodOnlineGetGlobalResourceObject(String, String)
Gets an application-level resource object based on the specified OnlineClassKey and OnlineResourceKey properties.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineGetGlobalResourceObject(String, String, Type, String)
Gets an application-level resource object based on the specified OnlineClassKey and OnlineResourceKey properties, object type, and property name of the resource.
(Inherited from OnlineTemplateControl.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
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 methodOnlineGetLocalResourceObject(String)
Gets a page-level resource object based on the specified OnlineResourceKey property.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineGetLocalResourceObject(String, Type, String)
Gets a page-level resource object based on the specified OnlineResourceKey property, object type, and property name.
(Inherited from OnlineTemplateControl.)
Public methodOnlineGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Protected methodGetSiteID
Get site ID either from context or use current site ID
Public methodGetString
Returns localized string.
(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 methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineGetUniqueIDRelativeTo
Returns the prefixed portion of the OnlineUniqueID property of the specified control.
(Inherited from OnlineControl.)
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 methodGetWireframeText
Ensures that the given text is not empty
(Inherited from CMSAbstractWebPart.)
Public methodOnlineHasControls
Determines if the server control contains any child controls.
(Inherited from OnlineControl.)
Protected methodOnlineHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from OnlineControl.)
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 methodOnlineInitializeAsUserControl
Initializes the OnlineUserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly.
(Inherited from OnlineUserControl.)
Protected methodOnlineIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from OnlineControl.)
Public methodLoadContent
Load the content to the web part.
(Inherited from CMSAbstractWebPart.)
Public methodOnlineLoadControl(String)
Loads a OnlineControl object from a file based on a specified virtual path.
(Inherited from OnlineTemplateControl.)
Public methodOnlineLoadControl(Type,  Object )
Loads a OnlineControl object based on a specified type and constructor parameters.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineLoadControlState
Restores control-state information from a previous page request that was saved by the OnlineSaveControlState  method.
(Inherited from OnlineControl.)
Protected methodLoadStep
Loads the step.
(Inherited from CMSAbstractWebPart.)
Public methodOnlineLoadTemplate
Obtains an instance of the OnlineITemplate interface from an external file.
(Inherited from OnlineTemplateControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Protected methodOnlineLoadViewState
Restores the view-state information from a previous user control request that was saved by the OnlineSaveViewState  method.
(Inherited from OnlineUserControl.)
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 methodOnlineMapPath
Assigns a virtual file path, either absolute or relative, to a physical file path.
(Inherited from OnlineUserControl.)
Protected methodOnlineMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from OnlineControl.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineOnAbortTransaction
Raises the OnlineAbortTransaction event.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from OnlineControl.)
Protected methodOnlineOnCommitTransaction
Raises the OnlineCommitTransaction event.
(Inherited from OnlineTemplateControl.)
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 methodOnlineOnDataBinding
Raises the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineOnError
Raises the OnlineError event.
(Inherited from OnlineTemplateControl.)
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 methodOnlineOnUnload
Raises the OnlineUnload event.
(Inherited from OnlineControl.)
Protected methodOnlineOpenFile
Gets a OnlineStream used to read a file.
(Inherited from OnlineControl.)
Public methodOnlineParseControl(String)
Parses an input string into a OnlineControl object on the Web Forms page or user control.
(Inherited from OnlineTemplateControl.)
Public methodOnlineParseControl(String, Boolean)
Parses an input string into a OnlineControl object on the ASP.NET Web page or user control.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from OnlineControl.)
Public methodOnlineReadStringResource
Reads a string resource. The OnlineReadStringResource  method is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
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.)
Protected methodOnlineRemovedControl
Called after a child control is removed from the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Public methodRemoveVariantFromCache
Removes the variant from cache.
(Inherited from CMSAbstractWebPart.)
Protected methodRender
Renders the control.
(Inherited from CMSAbstractWebPart.)
Public methodOnlineRenderControl(HtmlTextWriter)
Outputs server control content to a provided OnlineHtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from OnlineControl.)
Protected methodOnlineRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided OnlineHtmlTextWriter object using a provided OnlineControlAdapter object.
(Inherited from OnlineControl.)
Protected methodOnlineRenderChildren
Outputs the content of a server control's children to a provided OnlineHtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from OnlineControl.)
Protected methodOnlineResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from OnlineControl.)
Public methodOnlineResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from OnlineControl.)
Public methodResolveMacros
Resolves the macros within current WebPart context.
(Inherited from CMSAbstractWebPart.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Protected methodOnlineSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from OnlineControl.)
Protected methodSaveStepData
Saves the wizard step data.
(Inherited from CMSAbstractWebPart.)
Protected methodOnlineSaveViewState
Saves any user control view-state changes that have occurred since the last page postback.
(Inherited from OnlineUserControl.)
Public methodSetBreadcrumbs
Sets breadcrumbs based on UI context data
Public methodSetContext
Sets the web part context.
(Inherited from CMSAbstractWebPart.)
Protected methodOnlineSetDesignModeState
Sets design-time data for a control.
(Inherited from OnlineControl.)
Protected methodSetHeaderControls
Initializes the page controls
Public methodOnlineSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from OnlineControl.)
Protected methodOnlineSetStringResourcePointer
Sets a pointer to a string resource. The OnlineSetStringResourcePointer(Object, Int32) method is used by generated classes and is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
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.)
Public methodOnlineTestDeviceFilter
Returns a Boolean value indicating whether a device filter applies to the HTTP request.
(Inherited from OnlineTemplateControl.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Protected methodOnlineTrackViewState
Causes tracking of view-state changes to the server control so they can be stored in the server control's OnlineStateBag object. This object is accessible through the OnlineViewState property.
(Inherited from OnlineControl.)
Protected methodValidateStepData
Validates the wizard step data.
(Inherited from CMSAbstractWebPart.)
Protected methodOnlineWriteUTF8ResourceString
Writes a resource string to an OnlineHtmlTextWriter control. The OnlineWriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) method is used by generated classes and is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String)
Evaluates an XPath data-binding expression.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, String)
Evaluates an XPath data-binding expression using the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPathSelect(String)
Evaluates an XPath data-binding expression and returns a node collection that implements the OnlineIEnumerable interface.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPathSelect(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the OnlineIEnumerable interface.
(Inherited from OnlineTemplateControl.)
Back to 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 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 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.)
Back to 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 fieldmUpdatePanel
Update panel.
(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.)
Back to Top
Properties

  NameDescription
Protected propertyOnlineAdapter
Gets the browser-specific adapter for the control.
(Inherited from OnlineControl.)
Public propertyAdditonalCssClass
Gets or sets the additional class which is added to the web part content panel
(Inherited from CMSAbstractWebPart.)
Public propertyOnlineApplication
Gets the OnlineApplication object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyOnlineAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the OnlinePage or OnlineUserControl object that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineAppRelativeVirtualPath
Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineAttributes
Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
(Inherited from OnlineUserControl.)
Protected propertyOnlineAutoHandlersObsolete.
The OnlineAutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineBindingContainer
Gets the control that contains this control's data binding.
(Inherited from OnlineControl.)
Public propertyOnlineCache
Gets the OnlineCache object that is associated with the application that contains the user control.
(Inherited from OnlineUserControl.)
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 propertyOnlineCachePolicy
Gets a reference to a collection of caching parameters for this user control.
(Inherited from OnlineUserControl.)
Public propertyOnlineClientID
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from OnlineControl.)
Public propertyOnlineClientIDMode
Gets or sets the algorithm that is used to generate the value of the OnlineClientID property.
(Inherited from OnlineControl.)
Protected propertyOnlineClientIDSeparator
Gets a character value representing the separator character used in the OnlineClientID property.
(Inherited from OnlineControl.)
Public propertyComments
Comments.
(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.)
Protected propertyOnlineContext
Gets the OnlineHttpContext object associated with the server control for the current Web request.
(Inherited from OnlineControl.)
Public propertyContextResolver
Web part context resolver.
(Inherited from CMSAbstractWebPart.)
Public propertyControlContext
Control context.
(Inherited from CMSAbstractWebPart.)
Public propertyOnlineControls
Gets a OnlineControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from OnlineControl.)
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 propertyOnlineDataItemContainer
Gets a reference to the naming container if the naming container implements OnlineIDataItemContainer.
(Inherited from OnlineControl.)
Public propertyOnlineDataKeysContainer
Gets a reference to the naming container if the naming container implements OnlineIDataKeysControl.
(Inherited from OnlineControl.)
Protected propertyOnlineDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from OnlineControl.)
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.)
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyElementName
Element's name
Public propertyEnabled
Enabled.
(Inherited from CMSAbstractWebPart.)
Public propertyEnableOutputFilter
Enable output filter
(Inherited from CMSAbstractWebPart.)
Public propertyOnlineEnableTheming
Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the OnlineTemplateControl class.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineEnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from OnlineControl.)
Protected propertyOnlineEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from OnlineControl.)
Protected propertyOnlineHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from OnlineControl.)
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.)
Protected propertyOnlineChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from OnlineControl.)
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 propertyOnlineID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from OnlineControl.)
Protected propertyOnlineIdSeparator
Gets the character used to separate control identifiers.
(Inherited from OnlineControl.)
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.
Protected propertyOnlineIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from OnlineControl.)
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 propertyOnlineIsPostBack
Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.
(Inherited from OnlineUserControl.)
Protected propertyOnlineIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from OnlineControl.)
Public propertyIsVariant
Indicates whether this web part is a variant of an existing web part.
(Inherited from CMSAbstractWebPart.)
Protected propertyOnlineIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from OnlineControl.)
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 propertyIsWireframe
Returns true if the web part represents wireframe
(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.)
Protected propertyOnlineLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by OnlineID instead of index.
(Inherited from OnlineControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyOnlineNamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same OnlineID property value.
(Inherited from OnlineControl.)
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 propertyOnlinePage
Gets a reference to the OnlinePage instance that contains the server control.
(Inherited from OnlineControl.)
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 propertyOnlineParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from OnlineControl.)
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 propertyOnlineRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from OnlineControl.)
Public propertyOnlineRequest
Gets the OnlineHttpRequest object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyResourceName
UI element's resource name
Public propertyOnlineResponse
Gets the OnlineHttpResponse object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyRootElementID
Gets the root element ID. Root UI element holds the very top UIElement which is open in a dialog.
Public propertyOnlineServer
Gets the OnlineHttpServerUtility object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyOnlineSession
Gets the OnlineHttpSessionState object for the current Web request.
(Inherited from OnlineUserControl.)
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 propertySimpleRender
If true, the web part renders as simple as possible
(Inherited from CMSAbstractWebPart.)
Public propertyOnlineSite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from OnlineControl.)
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.)
Protected propertyOnlineSupportAutoEvents
Gets a value indicating whether the OnlineTemplateControl control supports automatic events.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineTemplateSourceDirectory
Gets the virtual directory of the OnlinePage or OnlineUserControl that contains the current server control.
(Inherited from OnlineControl.)
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
Public propertyOnlineTrace
Gets the OnlineTraceContext object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyOnlineUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from OnlineControl.)
Public propertyUpdatePanel
Update panel of the web part.
(Inherited from CMSAbstractWebPart.)
Public propertyUseContainer
Flag if the container should be used for the wireframe 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.)
Protected propertyOnlineViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from OnlineControl.)
Protected propertyOnlineViewStateIgnoresCase
Gets a value that indicates whether the OnlineStateBag object is case-insensitive.
(Inherited from OnlineControl.)
Public propertyOnlineViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from OnlineControl.)
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.)
Back to Top
Events

  NameDescription
Public eventOnlineAbortTransaction
Occurs when a user ends a transaction.
(Inherited from OnlineTemplateControl.)
Public eventOnlineCommitTransaction
Occurs when a transaction completes.
(Inherited from OnlineTemplateControl.)
Public eventOnlineDataBinding
Occurs when the server control binds to a data source.
(Inherited from OnlineControl.)
Public eventOnlineDisposed
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from OnlineControl.)
Public eventOnlineError
Occurs when an unhandled exception is thrown.
(Inherited from OnlineTemplateControl.)
Public eventOnlineInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from OnlineControl.)
Public eventOnlineLoad
Occurs when the server control is loaded into the OnlinePage object.
(Inherited from OnlineControl.)
Public eventOnlinePreRender
Occurs after the OnlineControl object is loaded but prior to rendering.
(Inherited from OnlineControl.)
Public eventOnlineUnload
Occurs when the server control is unloaded from memory.
(Inherited from OnlineControl.)
Back to Top
See Also