CMSAbstractUIWebpart Methods |
The CMSAbstractUIWebpart type exposes the following members.
Name | Description | |
---|---|---|
![]() | AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) |
![]() | AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) |
![]() | AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) |
![]() | AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) |
![]() | AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) |
![]() | AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) |
![]() | ClearCache |
Causes clearing the control data cache, override to implement the data reloading procedure.
(Inherited from CMSAbstractWebPart.) |
![]() | CreateChildControls |
Creates child controls within the web part.
(Inherited from CMSAbstractWebPart.) |
![]() | DisplayBreadcrumbs |
Indicates whether the breadcrumbs should be displayed according to the given UIContext.
|
![]() | EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) |
![]() | EnsureVariants |
Ensures the web part variants
(Inherited from CMSAbstractWebPart.) |
![]() | Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) |
![]() | Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) |
![]() | EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) |
![]() | EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) |
![]() | EvalDouble |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) |
![]() | EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) |
![]() | EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) |
![]() | EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) |
![]() | EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) |
![]() | EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) |
![]() | EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) |
![]() | EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) |
![]() | ExecuteForAllNested |
Executes the given action for all nested web parts
(Inherited from CMSAbstractWebPart.) |
![]() | GetBoolContextValue |
Returns bool property value. If property is not set, returns value from the UI context with the same name.
|
![]() | GetBothResizerScript |
Gets the script for horizontal resizer.
(Inherited from CMSAbstractWebPart.) |
![]() | GetCacheDependency |
Gets the cache dependency for the control.
(Inherited from CMSAbstractWebPart.) |
![]() | GetContainerId |
Gets the ID of the container encapsulating the web part
(Inherited from CMSAbstractWebPart.) |
![]() | GetDefaultCacheDependendencies |
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractWebPart.) |
![]() | GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) |
![]() | GetHorizontalResizerScript |
Gets the script for horizontal resizer.
(Inherited from CMSAbstractWebPart.) |
![]() | GetIdentifier |
Gets web part identifier.
(Inherited from CMSAbstractWebPart.) |
![]() | GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) |
![]() | GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) |
![]() | GetIntContextValue |
Returns int property value. If value is empty, try to get it from UI context.
|
![]() | GetSiteID |
Get site ID either from context or use current site ID
|
![]() | GetString |
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.) |
![]() | GetStringContextValue |
Returns string property value. If value is empty, try to get it from UI context.
|
![]() | GetStringValue |
Gets the string value of the web part
(Inherited from CMSAbstractWebPart.) |
![]() | GetValue |
Returns the value of the given web part property property.
(Inherited from CMSAbstractWebPart.) |
![]() | GetVariantID |
Gets the variant ID for rendering
(Inherited from CMSAbstractWebPart.) |
![]() | GetVerticalResizerScript |
Gets the script for vertical resizer.
(Inherited from CMSAbstractWebPart.) |
![]() | CheckEditPermissions |
Returns if element is authorized per modifying object
|
![]() | CheckUIPermissions |
Check permissions for UI elements
|
![]() | CheckViewPermissions |
Returns if user is allowed to read content based on content's object type
|
![]() | LoadContent |
Load the content to the web part.
(Inherited from CMSAbstractWebPart.) |
![]() | LoadStep |
Loads the step.
(Inherited from CMSAbstractWebPart.) |
![]() | LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) |
![]() | LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) |
![]() | LogEval |
Logs the evaluation of the given column to the debug
(Inherited from CMSAbstractWebPart.) |
![]() | ManagePaneTitle |
Handles displaying page title and breadcrumbs
|
![]() | ManageTexts |
Displays all information to messages placeholder based by element's properties
|
![]() | ManageVersionTab |
Adds version tab to collection.
|
![]() | 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.) |
![]() | OnInit |
Init event handler.
(Inherited from CMSAbstractWebPart.) |
![]() | OnLoad |
Load event handler.
(Inherited from CMSAbstractWebPart.) |
![]() | OnPreRender |
PreRender event handler.
(Inherited from CMSAbstractWebPart.) |
![]() | RegisterBreadcrumbsScript |
Registers the breadcrumbs script
|
![]() | ReleaseContext |
Releases the web part context.
(Inherited from CMSAbstractWebPart.) |
![]() | ReloadData |
Causes reloading the data, override to implement the data reloading procedure.
(Inherited from CMSAbstractWebPart.) |
![]() | RemoveVariantFromCache |
Removes the variant from cache.
(Inherited from CMSAbstractWebPart.) |
![]() | Render |
Renders the control.
(Inherited from CMSAbstractWebPart.) |
![]() | ResolveMacros |
Resolves the macros within current WebPart context.
(Inherited from CMSAbstractWebPart.) |
![]() | ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) |
![]() | SaveStepData |
Saves the wizard step data.
(Inherited from CMSAbstractWebPart.) |
![]() | SetBreadcrumbs |
Sets breadcrumbs based on UI context data
|
![]() | SetContext |
Sets the web part context.
(Inherited from CMSAbstractWebPart.) |
![]() | SetHeaderControls |
Initializes the page controls
|
![]() | SetTitle |
Sets title based on UI context data
|
![]() | SetValue |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from CMSAbstractWebPart.) |
![]() | ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) |
![]() | ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
![]() | ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) |
![]() | ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
![]() | ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
![]() | ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
![]() | ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
![]() | StepFinished |
Allows you to execute additional logic after finish/save step event.
(Inherited from CMSAbstractWebPart.) |
![]() | StepLoaded |
Allows you to execute additional logic after load step event.
(Inherited from CMSAbstractWebPart.) |
![]() | ValidateStepData |
Validates the wizard step data.
(Inherited from CMSAbstractWebPart.) |
Name | Description | |
---|---|---|
![]() | 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.) |
![]() | GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |