Click or drag to resize
CMSAbstractLayoutWebPart Methods

The CMSAbstractLayoutWebPart type exposes the following members.

Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodAddControl(String)
Adds the control to the layout.
Protected methodAddControl(Control)
Adds the control to the layout.
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.)
Protected methodAddHeaderContainer
Adds the container for the header to the layout.
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.)
Protected methodAddWebPart
Adds the web part to the layout
Protected methodAddZone
Adds the zone with given ID to the layout.
Protected methodAppend
Appends the given text to the layout.
Protected methodAppendAction
Appends the given action
Protected methodAppendAddAction
Appends the add to property action (increases by 1).
Protected methodAppendItemEnd
Appends the code to render the item end
Protected methodAppendItemsInfo
Appends the items information
Protected methodAppendItemStart
Appends the code to render the item start
Protected methodAppendNextItemAction
Appends the action to switch to the next item
Protected methodAppendPreviousItemAction
Appends the action to switch to the previous item
Protected methodAppendRemoveAction
Appends the add to property action (decreases by 1).
Public methodClearCache
Causes clearing the control data cache, override to implement the data reloading procedure.
(Inherited from CMSAbstractWebPart.)
Protected methodClearLayout
Clears the currently generated layout
Protected methodCreateChildControls
Creates the control child controls
(Overrides CMSAbstractWebPartCreateChildControls.)
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 methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(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 methodExecuteForAllVariants
Executes the given action for all nested web parts
(Inherited from CMSAbstractWebPart.)
Protected methodFinishLayout
Finishes the layout designing.
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 methodGetLastCurrentItem
Gets the value of the last current item as saved in a cookie
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.)
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.)
Public methodLoadContent
Load the content to the web part.
(Inherited from CMSAbstractWebPart.)
Public methodLoadLayout
Loads the web part layout.
Protected methodLoadStep
Loads the step.
(Inherited from CMSAbstractWebPart.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Protected methodLoadZones
Loads the web part zones contained within the web part.
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodLogEval
Logs the evaluation of the given column to the debug
(Inherited from CMSAbstractWebPart.)
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 methodPrepareLayout
Prepares the web part layout.
Protected methodRegisterChangeLayoutItemScript
Registers the script that changes the currently displayed item of the wizard
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 methodSetContext
Sets the web part context.
(Inherited from CMSAbstractWebPart.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from CMSAbstractWebPart.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
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 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 methodStartLayout
Starts the rendering of the layout.
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.)
Protected methodViewModeIsDesign
Returns true, if the web part view mode is design mode
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